OpenFOAM logo
Open Source CFD Toolkit

fvMesh Class Reference

Inheritance diagram for fvMesh:

Inheritance graph
[legend]
Collaboration diagram for fvMesh:

Collaboration graph
[legend]
List of all members.

Public Types

typedef fvMesh Mesh
typedef fvBoundaryMesh BoundaryMesh

Public Member Functions

 ClassName ("fvMesh")
 fvMesh (const IOobject &io)
 Construct from IOobject.
 fvMesh (const IOobject &io, const pointField &points, const faceList &faces, const cellList &cells)
 Construct from components without boundary.
virtual ~fvMesh ()
void addFvPatches (const List< polyPatch * > &)
 Add boundary patches. Constructor helper.
virtual readUpdateState readUpdate ()
 Update the mesh based on the mesh files saved in time.
const Timetime () const
 Return reference to DB.
const wordname () const
 Return reference to name.
const fvBoundaryMeshboundary () const
 Return reference to boundary mesh.
const Vector< label > & directions () const
 Return the vector of valid directions in mesh.
label nD () const
 Return the number of valid dimensions in the mesh.
const lduAddressingldu () const
 Return ldu addressing.
const unallocLabelListowner () const
 Internal face owner.
const unallocLabelListneighbour () const
 Internal face neighbour.
const scalarFieldV () const
 Return cell volumes.
const scalarFieldV0 () const
 Return old-time cell volumes.
const scalarFieldV00 () const
 Return old-old-time cell volumes.
const surfaceVectorFieldSf () const
 Return cell face area vectors.
const surfaceScalarFieldmagSf () const
 Return cell face area magnitudes.
const surfaceScalarFieldphi () const
 Return cell face motion fluxes.
const volVectorFieldC () const
 Return cell centres as volVectorField.
const surfaceVectorFieldCf () const
 Return face centres as surfaceVectorField.
void constructAndClear () const
 Construct all optional data and clear basic info from basicMesh.
virtual void updateMesh (const mapPolyMesh &mpm)
 Update mesh corresponding to the given map.
virtual tmp< scalarFieldmovePoints (const vectorField &)
 Move points, returns volumes swept by faces in motion.
virtual void mapFields (const mapPolyMesh &mpm)
 Map all fields in time using given map.
void removeFvBoundary ()
 Remove boundary patches. Warning: fvPatchFields hold ref to.
surfaceScalarFieldsetPhi ()
 Return cell face motion fluxes.
scalarFieldsetV0 ()
 Return old-time cell volumes.
virtual bool write (IOstream::streamFormat fmt, IOstream::versionNumber ver, IOstream::compressionType cmp) const
 Write the underlying polyMesh and other data.
virtual bool write () const
 Write mesh using IO settings from time.
bool operator!= (const fvMesh &) const
bool operator== (const fvMesh &) const

Member Typedef Documentation

typedef fvBoundaryMesh BoundaryMesh
 

Definition at line 173 of file fvMesh.H.

typedef fvMesh Mesh
 

Definition at line 172 of file fvMesh.H.


Constructor & Destructor Documentation

fvMesh const IOobject io  )  [explicit]
 

Construct from IOobject.

fvMesh const IOobject io,
const pointField points,
const faceList faces,
const cellList cells
 

Construct from components without boundary.

Boundary is added using addFvPatches() member function

virtual ~fvMesh  )  [virtual]
 


Member Function Documentation

void addFvPatches const List< polyPatch * > &   ) 
 

Add boundary patches. Constructor helper.

const fvBoundaryMesh& boundary  )  const
 

Return reference to boundary mesh.

Referenced by fvBoundaryMeshMapper::fvBoundaryMeshMapper(), fvMeshLduAddressing::fvMeshLduAddressing(), and tetPolyBoundaryMapperFaceDecomp::tetPolyBoundaryMapperFaceDecomp().

const volVectorField& C  )  const
 

Return cell centres as volVectorField.

Referenced by volMesh::size().

const surfaceVectorField& Cf  )  const
 

Return face centres as surfaceVectorField.

Referenced by surfaceMesh::size().

ClassName "fvMesh"   ) 
 

void constructAndClear  )  const
 

Construct all optional data and clear basic info from basicMesh.

const Vector<label>& directions  )  const [inline]
 

Return the vector of valid directions in mesh.

defined according to the presence of empty patches

Definition at line 242 of file fvMesh.H.

const lduAddressing& ldu  )  const
 

Return ldu addressing.

const surfaceScalarField& magSf  )  const
 

Return cell face area magnitudes.

virtual void mapFields const mapPolyMesh mpm  )  [virtual]
 

Map all fields in time using given map.

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

Move points, returns volumes swept by faces in motion.

const word& name  )  const [inline]
 

Return reference to name.

Note: name() is currently ambiguous due to derivation from surfaceInterpolation

Reimplemented from IOdictionary.

Definition at line 230 of file fvMesh.H.

References Foam::cmptSum().

Here is the call graph for this function:

label nD  )  const [inline]
 

Return the number of valid dimensions in the mesh.

Definition at line 248 of file fvMesh.H.

const unallocLabelList& neighbour  )  const [inline]
 

Internal face neighbour.

Definition at line 264 of file fvMesh.H.

References Foam::scalarField, Foam::surfaceScalarField, Foam::surfaceVectorField, Foam::vectorField, and Foam::volVectorField.

bool operator!= const fvMesh  )  const
 

bool operator== const fvMesh  )  const
 

const unallocLabelList& owner  )  const [inline]
 

Internal face owner.

Definition at line 258 of file fvMesh.H.

References Foam::scalarField, and Foam::surfaceVectorField.

const surfaceScalarField& phi  )  const
 

Return cell face motion fluxes.

virtual readUpdateState readUpdate  )  [virtual]
 

Update the mesh based on the mesh files saved in time.

directories

Reimplemented from polyMesh.

void removeFvBoundary  ) 
 

Remove boundary patches. Warning: fvPatchFields hold ref to.

these fvPatches.

surfaceScalarField& setPhi  ) 
 

Return cell face motion fluxes.

scalarField& setV0  ) 
 

Return old-time cell volumes.

const surfaceVectorField& Sf  )  const
 

Return cell face area vectors.

const Time& time  )  const [inline]
 

Return reference to DB.

Reimplemented from objectRegistry.

Definition at line 220 of file fvMesh.H.

virtual void updateMesh const mapPolyMesh mpm  )  [virtual]
 

Update mesh corresponding to the given map.

Reimplemented from polyMesh.

const scalarField& V  )  const
 

Return cell volumes.

Referenced by spray::evaporationSource().

const scalarField& V0  )  const
 

Return old-time cell volumes.

const scalarField& V00  )  const
 

Return old-old-time cell volumes.

virtual bool write  )  const [virtual]
 

Write mesh using IO settings from time.

Reimplemented from objectRegistry.

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

Write the underlying polyMesh and other data.

Reimplemented from objectRegistry.


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