OpenFOAM logo
Open Source CFD Toolkit

faMesh Class Reference

Inheritance diagram for faMesh:

Inheritance graph
[legend]
Collaboration diagram for faMesh:

Collaboration graph
[legend]
List of all members.

Public Types

typedef faMesh Mesh
typedef faBoundaryMesh BoundaryMesh

Public Member Functions

 TypeName ("faMesh")
 faMesh (const polyMesh &m, IOobject::readOption r=IOobject::MUST_READ, IOobject::writeOption w=IOobject::AUTO_WRITE)
 Construct from objectRegistry, polyMesh reference.
 faMesh (const polyMesh &m, const labelList &faceLabels, IOobject::readOption r=IOobject::NO_READ, IOobject::writeOption w=IOobject::AUTO_WRITE)
 Construct from components without boundary.
virtual ~faMesh ()
fileName meshDir () const
 Return the local mesh directory (dbDir()/meshSubDir).
const Timetime () const
 Return reference to time.
label nPoints () const
 Mesh size parameters.
label nEdges () const
label nInternalEdges () const
label nFaces () const
const pointFieldpoints () const
 Return mesh points.
const edgeListedges () const
 Return edges.
const faceListfaces () const
 Return faces.
const labelListedgeOwner () const
 Edge owner addresing.
const labelListedgeNeighbour () const
 Edge neighbour addressing.
void addFaPatches (const List< faPatch * > &)
 Add boundary patches. Constructor helper.
const objectRegistrydb () const
 Return reference to the mesh database.
const faBoundaryMeshboundary () const
 Return constant reference to boundary mesh.
faBoundaryMeshboundary ()
 Return reference to boundary mesh.
const labelListfaceLabels () const
 Return faMesh face labels.
const faProcTopologyparallelData () const
 Return parallel info.
bool moving () const
 Is mesh moving.
virtual tmp< scalarFieldmovePoints (const vectorField &)
 Move points, returns volumes swept by faces in motion.
const indirectPrimitivePatchpatch () const
 Return constant reference to primitive patch.
indirectPrimitivePatchpatch ()
 Return reference to primitive patch.
const lduAddressingldu () const
 Return ldu addressing.
const labelListpatchStarts () const
 Return patch starts.
const edgeVectorFieldLe () const
 Return edge length vectors.
const edgeScalarFieldmagLe () const
 Return edge length magnitudes.
const areaVectorFieldcentres () const
 Return face centres as areaVectorField.
const edgeVectorFieldedgeCentres () const
 Return edge centres as edgeVectorField.
const scalarFieldS () const
 Return face areas.
const scalarFieldS0 () const
 Return old-time face areas.
const scalarFieldS00 () const
 Return old-old-time face areas.
const areaVectorFieldfaceAreaNormals () const
 Return face area normals.
const edgeVectorFieldedgeAreaNormals () const
 Return edge area normals.
const vectorFieldpointAreaNormals () const
 Return point area normals.
const areaScalarFieldfaceCurvatures () const
 Return face curvatures.
const FieldField< Field, tensor > & edgeTransformTensors () const
 Return edge transformation tensors.
labelList internalPoints () const
 Return internal point labels.
labelList boundaryPoints () const
 Return boundary point labels.
tmp< edgeScalarFieldedgeLengthCorrection () const
 Return edge length correction.
const unallocLabelListowner () const
 Internal face owner.
const unallocLabelListneighbour () const
 Internal face neighbour.
bool write (IOstream::streamFormat fmt, IOstream::versionNumber ver, IOstream::compressionType cmp) const
 Write mesh.
const polyMeshoperator() () const
 Return reference to polyMesh.
bool operator!= (const faMesh &m) const
bool operator== (const faMesh &m) const

Static Public Attributes

word meshSubDir
 Return the mesh sub-directory name (usually "faMesh").

Friends

Ostreamoperator<< (Ostream &, const faMesh &)

Member Typedef Documentation

typedef faBoundaryMesh BoundaryMesh
 

Definition at line 245 of file faMesh.H.

typedef faMesh Mesh
 

Definition at line 244 of file faMesh.H.


Constructor & Destructor Documentation

faMesh const polyMesh m,
IOobject::readOption  r = IOobject::MUST_READ,
IOobject::writeOption  w = IOobject::AUTO_WRITE
 

Construct from objectRegistry, polyMesh reference.

and read/write options

faMesh const polyMesh m,
const labelList faceLabels,
IOobject::readOption  r = IOobject::NO_READ,
IOobject::writeOption  w = IOobject::AUTO_WRITE
 

Construct from components without boundary.

Boundary is added using addFaPatches() member function

virtual ~faMesh  )  [virtual]
 


Member Function Documentation

void addFaPatches const List< faPatch * > &   ) 
 

Add boundary patches. Constructor helper.

faBoundaryMesh& boundary  ) 
 

Return reference to boundary mesh.

const faBoundaryMesh& boundary  )  const
 

Return constant reference to boundary mesh.

Referenced by lduAddressingFaMesh::lduAddressingFaMesh().

labelList boundaryPoints  )  const
 

Return boundary point labels.

const areaVectorField& centres  )  const
 

Return face centres as areaVectorField.

const objectRegistry& db  )  const
 

Return reference to the mesh database.

Reimplemented from IOobject.

const edgeVectorField& edgeAreaNormals  )  const
 

Return edge area normals.

const edgeVectorField& edgeCentres  )  const
 

Return edge centres as edgeVectorField.

tmp<edgeScalarField> edgeLengthCorrection  )  const
 

Return edge length correction.

const labelList& edgeNeighbour  )  const [inline]
 

Edge neighbour addressing.

Definition at line 339 of file faMesh.H.

References Foam::labelList.

const labelList& edgeOwner  )  const [inline]
 

Edge owner addresing.

Definition at line 333 of file faMesh.H.

const edgeList& edges  )  const
 

Return edges.

const FieldField<Field, tensor>& edgeTransformTensors  )  const
 

Return edge transformation tensors.

const areaVectorField& faceAreaNormals  )  const
 

Return face area normals.

const areaScalarField& faceCurvatures  )  const
 

Return face curvatures.

const labelList& faceLabels  )  const [inline]
 

Return faMesh face labels.

Definition at line 359 of file faMesh.H.

const faceList& faces  )  const
 

Return faces.

labelList internalPoints  )  const
 

Return internal point labels.

const lduAddressing& ldu  )  const
 

Return ldu addressing.

const edgeVectorField& Le  )  const
 

Return edge length vectors.

const edgeScalarField& magLe  )  const
 

Return edge length magnitudes.

fileName meshDir  )  const
 

Return the local mesh directory (dbDir()/meshSubDir).

virtual tmp<scalarField> movePoints const vectorField  )  [virtual]
 

Move points, returns volumes swept by faces in motion.

bool moving  )  const [inline]
 

Is mesh moving.

Definition at line 372 of file faMesh.H.

References Foam::areaScalarField, Foam::areaVectorField, Foam::edgeScalarField, Foam::edgeVectorField, Foam::indirectPrimitivePatch, Foam::labelList, Foam::scalarField, Foam::unallocLabelList, and Foam::vectorField.

label nEdges  )  const [inline]
 

Definition at line 306 of file faMesh.H.

const unallocLabelList& neighbour  )  const [inline]
 

Internal face neighbour.

Definition at line 450 of file faMesh.H.

label nFaces  )  const [inline]
 

Definition at line 316 of file faMesh.H.

References Foam::edgeList, Foam::faceList, and Foam::labelList.

label nInternalEdges  )  const [inline]
 

Definition at line 311 of file faMesh.H.

References Foam::pointField.

label nPoints  )  const [inline]
 

Mesh size parameters.

Definition at line 301 of file faMesh.H.

bool operator!= const faMesh m  )  const
 

const polyMesh& operator()  )  const [inline]
 

Return reference to polyMesh.

Definition at line 470 of file faMesh.H.

bool operator== const faMesh m  )  const
 

const unallocLabelList& owner  )  const [inline]
 

Internal face owner.

Definition at line 444 of file faMesh.H.

const faProcTopology& parallelData  )  const
 

Return parallel info.

indirectPrimitivePatch& patch  ) 
 

Return reference to primitive patch.

const indirectPrimitivePatch& patch  )  const
 

Return constant reference to primitive patch.

const labelList& patchStarts  )  const
 

Return patch starts.

const vectorField& pointAreaNormals  )  const
 

Return point area normals.

const pointField& points  )  const
 

Return mesh points.

const scalarField& S  )  const
 

Return face areas.

const scalarField& S0  )  const
 

Return old-time face areas.

const scalarField& S00  )  const
 

Return old-old-time face areas.

const Time& time  )  const
 

Return reference to time.

Reimplemented from IOobject.

TypeName "faMesh"   ) 
 

bool write IOstream::streamFormat  fmt,
IOstream::versionNumber  ver,
IOstream::compressionType  cmp
const [virtual]
 

Write mesh.

Reimplemented from regIOobject.


Friends And Related Function Documentation

Ostream& operator<< Ostream ,
const faMesh
[friend]
 


Member Data Documentation

word meshSubDir [static]
 

Return the mesh sub-directory name (usually "faMesh").

Definition at line 254 of file faMesh.H.


The documentation for this class was generated from the following file:
For further information go to www.openfoam.org