OpenFOAM logo
The Open Source CFD Toolbox
  Source Guide OpenCFD Solutions Contact OpenFOAM

ensightPart Class Reference

Base class for ensightPartCells and ensightPartFaces. More...

Inheritance diagram for ensightPart:
Collaboration diagram for ensightPart:

List of all members.


Classes

class  localPoints
 track the points used by the part and map global to local indices More...

Public Member Functions

 TypeName ("ensightPart")
 Runtime type information.
 ensightPart ()
 Construct null.
 ensightPart (label partNumber, const string &partDescription)
 Construct empty part with number and description.
 ensightPart (label partNumber, const string &partDescription, const polyMesh &pMesh)
 Construct empty part with number and description.
 ensightPart (const ensightPart &)
 Construct as copy.
 declareRunTimeSelectionTable (autoPtr, ensightPart, istream,(Istream &is),(is))
autoPtr< ensightPartclone () const
 Construct and return clone.
virtual ~ensightPart ()
 Destructor.
virtual List< word > const & elementTypes () const
label size () const
 number of elements in this part
bool isCellData () const
 represents cell data
bool isFaceData () const
 represents face data
label number () const
 part number
const stringname () const
 part name or description
label materialId () const
 material id
void name (const string &value)
 non-const access
void materialId (const label value)
label offset () const
 offset for element ids
void renumber (labelList const &)
 renumber elements
bool writeSummary (Ostream &) const
 write summary information about the object
bool writeData (Ostream &) const
 write reconstruction information for the object
void writeGeometry (ensightGeoFile &) const
 write geometry
void writeScalarField (ensightFile &, const List< scalar > &field) const
 write scalar field
void writeVectorField (ensightFile &, const List< scalar > &field0, const List< scalar > &field1, const List< scalar > &field2) const
 write vector field components
template<class Type >
void writeField (ensightFile &, const Field< Type > &) const
 write generalized field components
void operator= (const ensightPart &)
 Disallow default bitwise assignment.

Static Public Member Functions

static autoPtr< ensightPartNew (Istream &is)
 Construct on freestore from Istream.

Protected Member Functions

void reconstruct (Istream &)
 reconstruct contents from Istream
bool isFieldDefined (const List< scalar > &) const
 check for fully defined fields
void writeHeader (ensightFile &, bool withDescription=false) const
 write the part header
void writeFieldList (ensightFile &os, const List< scalar > &field, const List< label > &idList) const
 write a scalar field for idList
virtual localPoints calcLocalPoints () const
 track points used
virtual void writeConnectivity (ensightGeoFile &os, const string &key, const labelList &idList, const labelList &pointMap) const
 write connectivities

Protected Attributes

label number_
 part number
string name_
 part name (or description)
labelListList elemLists_
 simple labelList with a name
label offset_
 start offset for elemLists_
label size_
 number of elements in this part
bool isCellData_
 cell or face data
label matId_
 material id (numeric)
const polyMeshmeshPtr_
 mesh reference used

Friends

Ostreamoperator<< (Ostream &, const ensightPart &)
 write data (reconstruction information)
ensightGeoFileoperator<< (ensightGeoFile &, const ensightPart &)
 write geometry

Detailed Description

Base class for ensightPartCells and ensightPartFaces.

Source files

Definition at line 53 of file ensightPart.H.


Constructor & Destructor Documentation

ensightPart (  ) 

Construct null.

Definition at line 58 of file ensightPart.C.

ensightPart ( label  partNumber,
const string partDescription 
)

Construct empty part with number and description.

Definition at line 72 of file ensightPart.C.

ensightPart ( label  partNumber,
const string partDescription,
const polyMesh pMesh 
)

Construct empty part with number and description.

Definition at line 89 of file ensightPart.C.

ensightPart ( const ensightPart part  ) 

Construct as copy.

Definition at line 106 of file ensightPart.C.

~ensightPart (  )  [virtual]

Destructor.

Definition at line 146 of file ensightPart.C.


Member Function Documentation

void reconstruct ( Istream is  )  [protected]

reconstruct contents from Istream

Definition at line 152 of file ensightPart.C.

bool isFieldDefined ( const List< scalar > &  field  )  const [protected]

check for fully defined fields

Definition at line 35 of file ensightPart.C.

void writeHeader ( ensightFile os,
bool  withDescription = false 
) const [protected]

write the part header

Definition at line 29 of file ensightPartIO.C.

References ensightFile::newline(), ensightPart::number(), and ensightFile::write().

Referenced by ensightPart::writeField().

Here is the call graph for this function:

Here is the caller graph for this function:

void writeFieldList ( ensightFile os,
const List< scalar > &  field,
const List< label > &  idList 
) const [protected]

write a scalar field for idList

Definition at line 49 of file ensightPartIO.C.

References ensightPart::name(), ensightFile::newline(), and ensightFile::write().

Referenced by ensightPart::writeField().

Here is the call graph for this function:

Here is the caller graph for this function:

virtual localPoints calcLocalPoints (  )  const [inline, protected, virtual]

track points used

Definition at line 138 of file ensightPart.H.

virtual void writeConnectivity ( ensightGeoFile os,
const string key,
const labelList idList,
const labelList pointMap 
) const [inline, protected, virtual]

write connectivities

Definition at line 145 of file ensightPart.H.

TypeName ( "ensightPart"   ) 

Runtime type information.

declareRunTimeSelectionTable ( autoPtr  ,
ensightPart  ,
istream  ,
(Istream &is)  ,
(is)   
)

autoPtr<ensightPart> clone (  )  const [inline]

Construct and return clone.

Definition at line 195 of file ensightPart.H.

Foam::autoPtr< Foam::ensightPart > New ( Istream is  )  [static]

Construct on freestore from Istream.

Reimplemented in ensightPartCells, and ensightPartFaces.

Definition at line 121 of file ensightPart.C.

virtual List<word> const& elementTypes (  )  const [inline, virtual]

Reimplemented in ensightPartCells, and ensightPartFaces.

Definition at line 210 of file ensightPart.H.

Referenced by ensightPart::writeField().

Here is the caller graph for this function:

label size (  )  const [inline]

number of elements in this part

Definition at line 219 of file ensightPart.H.

Referenced by ensightPart::writeField().

Here is the caller graph for this function:

bool isCellData (  )  const [inline]

represents cell data

Definition at line 225 of file ensightPart.H.

References ensightPart::size_.

bool isFaceData (  )  const [inline]

represents face data

Definition at line 231 of file ensightPart.H.

References ensightPart::isCellData_.

label number (  )  const [inline]

part number

Definition at line 237 of file ensightPart.H.

References ensightPart::isCellData_.

Referenced by ensightPart::writeHeader().

Here is the caller graph for this function:

const string& name (  )  const [inline]

part name or description

Definition at line 243 of file ensightPart.H.

References ensightPart::number_.

Referenced by ensightPart::writeFieldList().

Here is the caller graph for this function:

label materialId (  )  const [inline]

material id

Definition at line 249 of file ensightPart.H.

References ensightPart::name_.

void name ( const string value  )  [inline]

non-const access

Definition at line 255 of file ensightPart.H.

References ensightPart::matId_.

void materialId ( const label  value  )  [inline]

Definition at line 260 of file ensightPart.H.

References ensightPart::name_.

label offset (  )  const [inline]

offset for element ids

Definition at line 266 of file ensightPart.H.

References ensightPart::matId_.

void renumber ( labelList const &  origId  ) 

renumber elements

Definition at line 176 of file ensightPart.C.

bool writeSummary ( Ostream os  )  const

write summary information about the object

Definition at line 73 of file ensightPartIO.C.

bool writeData ( Ostream os  )  const

write reconstruction information for the object

Definition at line 90 of file ensightPartIO.C.

void writeGeometry ( ensightGeoFile os  )  const

write geometry

Definition at line 114 of file ensightPartIO.C.

void writeScalarField ( ensightFile os,
const List< scalar > &  field 
) const

write scalar field

Definition at line 162 of file ensightPartIO.C.

void writeVectorField ( ensightFile os,
const List< scalar > &  field0,
const List< scalar > &  field1,
const List< scalar > &  field2 
) const

write vector field components

Definition at line 186 of file ensightPartIO.C.

void writeField ( ensightFile os,
const Field< Type > &  field 
) const [inline]

void operator= ( const ensightPart  )  [inline]

Disallow default bitwise assignment.

Definition at line 315 of file ensightPart.H.


Friends And Related Function Documentation

Ostream& operator<< ( Ostream ,
const ensightPart  
) [friend]

write data (reconstruction information)

ensightGeoFile& operator<< ( ensightGeoFile ,
const ensightPart  
) [friend]

write geometry


Member Data Documentation

label number_ [protected]

part number

Definition at line 66 of file ensightPart.H.

Referenced by ensightPart::name().

string name_ [protected]

part name (or description)

Definition at line 69 of file ensightPart.H.

Referenced by ensightPart::materialId().

simple labelList with a name

Definition at line 72 of file ensightPart.H.

Referenced by ensightPart::writeField().

label offset_ [protected]

start offset for elemLists_

Definition at line 75 of file ensightPart.H.

label size_ [protected]

number of elements in this part

Definition at line 78 of file ensightPart.H.

Referenced by ensightPart::isCellData().

bool isCellData_ [protected]

label matId_ [protected]

material id (numeric)

Definition at line 84 of file ensightPart.H.

Referenced by ensightPart::name(), and ensightPart::offset().

const polyMesh* meshPtr_ [protected]

mesh reference used

Definition at line 87 of file ensightPart.H.


The documentation for this class was generated from the following files:
Copyright © 2000-2009 OpenCFD Ltd