FreeFOAM The Cross-Platform CFD Toolkit
ensightPart Class Reference

Base class for ensightPartCells and ensightPartFaces. More...

#include <conversion/ensightPart.H>


Detailed Description

+ 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

Constructor & Destructor Documentation

Construct null.

Definition at line 66 of file ensightPart.C.

Referenced by ensightPart::clone().

ensightPart ( label  partNumber,
const string partDescription 
)

Construct empty part with number and description.

Definition at line 80 of file ensightPart.C.

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

Construct empty part with number and description.

Definition at line 97 of file ensightPart.C.

ensightPart ( const ensightPart part)

Construct as copy.

Definition at line 114 of file ensightPart.C.

~ensightPart ( )
virtual

Destructor.

Definition at line 154 of file ensightPart.C.


Member Function Documentation

void reconstruct ( Istream is)
protected
bool isFieldDefined ( const List< scalar > &  field) const
protected

check for fully defined fields

Definition at line 43 of file ensightPart.C.

References ensightPart::elemLists_, forAll, and List< T >::size().

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

write the part header

Definition at line 36 of file ensightPartIO.C.

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

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

write a scalar field for idList

Definition at line 56 of file ensightPartIO.C.

References forAll, ensightFile::newline(), List< T >::size(), ensightFile::write(), and ensightFile::writeUndef().

virtual localPoints calcLocalPoints ( ) const
inlineprotectedvirtual

track points used

Definition at line 143 of file ensightPart.H.

virtual void writeConnectivity ( ensightGeoFile os,
const string key,
const labelList idList,
const labelList pointMap 
) const
inlineprotectedvirtual

write connectivities

Definition at line 150 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 200 of file ensightPart.H.

References ensightPart::ensightPart().

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

Construct on freestore from Istream.

Reimplemented in ensightPartCells, and ensightPartFaces.

Definition at line 129 of file ensightPart.C.

References Foam::endl(), Foam::exit(), Foam::FatalIOError, and FatalIOErrorIn.

virtual List<word> const& elementTypes ( ) const
inlinevirtual

Reimplemented in ensightPartCells, and ensightPartFaces.

Definition at line 215 of file ensightPart.H.

label size ( ) const
inline

number of elements in this part

Definition at line 224 of file ensightPart.H.

References ensightPart::size_.

Referenced by ensightPart::writeSummary().

bool isCellData ( ) const
inline

represents cell data

Definition at line 230 of file ensightPart.H.

References ensightPart::isCellData_.

bool isFaceData ( ) const
inline

represents face data

Definition at line 236 of file ensightPart.H.

References ensightPart::isCellData_.

label number ( ) const
inline

part number

Definition at line 242 of file ensightPart.H.

References ensightPart::number_.

Referenced by ensightPart::writeSummary().

const string& name ( ) const
inline

part name or description

Definition at line 248 of file ensightPart.H.

References ensightPart::name_.

Referenced by ensightPart::writeSummary().

label materialId ( ) const
inline

material id

Definition at line 254 of file ensightPart.H.

References ensightPart::matId_.

void name ( const string value)
inline

non-const access

Definition at line 260 of file ensightPart.H.

References ensightPart::name_.

void materialId ( const label  value)
inline

Definition at line 265 of file ensightPart.H.

References ensightPart::matId_.

label offset ( ) const
inline

offset for element ids

Definition at line 271 of file ensightPart.H.

References ensightPart::offset_.

Referenced by ensightPart::writeSummary().

void renumber ( labelList const &  origId)

renumber elements

Definition at line 184 of file ensightPart.C.

References forAll, Foam::inplaceRenumber(), and List< T >::size().

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

write scalar field

Definition at line 169 of file ensightPartIO.C.

References ensightFile::allowUndef(), forAll, List< T >::size(), and ensightFile::writeKeyword().

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

write vector field components

Definition at line 193 of file ensightPartIO.C.

References ensightFile::allowUndef(), forAll, List< T >::size(), and ensightFile::writeKeyword().

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

write generalized field components

Definition at line 35 of file ensightPartI.H.

References Field< Type >::component(), forAll, List< Type >::size(), List< T >::size(), and ensightFile::writeKeyword().

void operator= ( const ensightPart )
inline

Disallow default bitwise assignment.

Definition at line 320 of file ensightPart.H.

References notImplemented.


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 71 of file ensightPart.H.

Referenced by ensightPart::number().

string name_
protected

part name (or description)

Definition at line 74 of file ensightPart.H.

Referenced by ensightPart::name().

labelListList elemLists_
protected

simple labelList with a name

Definition at line 77 of file ensightPart.H.

Referenced by ensightPart::isFieldDefined().

label offset_
protected

start offset for elemLists_

Definition at line 80 of file ensightPart.H.

Referenced by ensightPart::offset().

label size_
protected

number of elements in this part

Definition at line 83 of file ensightPart.H.

Referenced by ensightPart::size().

bool isCellData_
protected

cell or face data

Definition at line 86 of file ensightPart.H.

Referenced by ensightPartFaces::ensightPartFaces(), ensightPart::isCellData(), and ensightPart::isFaceData().

label matId_
protected

material id (numeric)

Definition at line 89 of file ensightPart.H.

Referenced by ensightPart::materialId().

const polyMesh* meshPtr_
protected

mesh reference used

Definition at line 92 of file ensightPart.H.


The documentation for this class was generated from the following files: