fvFieldDecomposer Class Reference

Finite Volume volume and surface field decomposer. More...

Classes

class  fieldsCache
 
class  patchFieldDecomposer
 Patch field decomposer class. More...
 
class  processorSurfacePatchFieldDecomposer
 Processor patch field decomposer class. Surface field is assumed. More...
 
class  processorVolPatchFieldDecomposer
 Processor patch field decomposer class. Maps either owner or. More...
 

Public Member Functions

 fvFieldDecomposer (const Foam::zero, const fvMesh &procMesh, const labelList &faceAddressing, const labelList &cellAddressing, const labelList &boundaryAddressing)
 Construct without mappers, added later with reset() More...
 
 fvFieldDecomposer (const fvMesh &completeMesh, const fvMesh &procMesh, const labelList &faceAddressing, const labelList &cellAddressing, const labelList &boundaryAddressing)
 Construct from components using information from the complete mesh. More...
 
 fvFieldDecomposer (const List< labelRange > &boundaryRanges, const labelUList &faceOwner, const labelUList &faceNeigbour, const fvMesh &procMesh, const labelList &faceAddressing, const labelList &cellAddressing, const labelList &boundaryAddressing)
 Construct from components without the complete mesh. More...
 
 ~fvFieldDecomposer ()=default
 Destructor. More...
 
bool empty () const
 True if no mappers have been allocated. More...
 
void clear ()
 Remove all mappers. More...
 
void reset (const fvMesh &completeMesh)
 Reset mappers using information from the complete mesh. More...
 
void reset (const List< labelRange > &boundaryRanges, const labelUList &faceOwner, const labelUList &faceNeigbour)
 Reset mapper using information about the complete mesh. More...
 
template<class Type >
tmp< DimensionedField< Type, volMesh > > decomposeField (const DimensionedField< Type, volMesh > &field) const
 Decompose internal field. More...
 
template<class Type >
tmp< GeometricField< Type, fvPatchField, volMesh > > decomposeField (const GeometricField< Type, fvPatchField, volMesh > &field, const bool allowUnknownPatchFields=false) const
 Decompose volume field. More...
 
template<class Type >
tmp< GeometricField< Type, fvsPatchField, surfaceMesh > > decomposeField (const GeometricField< Type, fvsPatchField, surfaceMesh > &field) const
 Decompose surface field. More...
 
template<class GeoField >
void decomposeFields (const PtrList< GeoField > &fields) const
 Decompose list of fields. More...
 
template<class Type >
Foam::tmp< Foam::DimensionedField< Type, Foam::volMesh > > decomposeField (const DimensionedField< Type, volMesh > &field) const
 
template<class Type >
Foam::tmp< Foam::GeometricField< Type, Foam::fvPatchField, Foam::volMesh > > decomposeField (const GeometricField< Type, fvPatchField, volMesh > &field, const bool allowUnknownPatchFields) const
 
template<class Type >
Foam::tmp< Foam::GeometricField< Type, Foam::fvsPatchField, Foam::surfaceMesh > > decomposeField (const GeometricField< Type, fvsPatchField, surfaceMesh > &field) const
 

Static Public Attributes

static int verbose_ = 1
 Output verbosity when writing. More...
 

Detailed Description

Finite Volume volume and surface field decomposer.

Source files

Definition at line 58 of file fvFieldDecomposer.H.

Constructor & Destructor Documentation

◆ fvFieldDecomposer() [1/3]

fvFieldDecomposer ( const Foam::zero  ,
const fvMesh procMesh,
const labelList faceAddressing,
const labelList cellAddressing,
const labelList boundaryAddressing 
)

Construct without mappers, added later with reset()

Definition at line 136 of file fvFieldDecomposer.C.

◆ fvFieldDecomposer() [2/3]

fvFieldDecomposer ( const fvMesh completeMesh,
const fvMesh procMesh,
const labelList faceAddressing,
const labelList cellAddressing,
const labelList boundaryAddressing 
)

Construct from components using information from the complete mesh.

Definition at line 157 of file fvFieldDecomposer.C.

References fvFieldDecomposer::reset().

Here is the call graph for this function:

◆ fvFieldDecomposer() [3/3]

fvFieldDecomposer ( const List< labelRange > &  boundaryRanges,
const labelUList faceOwner,
const labelUList faceNeigbour,
const fvMesh procMesh,
const labelList faceAddressing,
const labelList cellAddressing,
const labelList boundaryAddressing 
)

Construct from components without the complete mesh.

Definition at line 179 of file fvFieldDecomposer.C.

References fvFieldDecomposer::reset().

Here is the call graph for this function:

◆ ~fvFieldDecomposer()

~fvFieldDecomposer ( )
default

Destructor.

Member Function Documentation

◆ empty()

bool empty ( ) const

True if no mappers have been allocated.

Definition at line 206 of file fvFieldDecomposer.C.

◆ clear()

void clear ( )

Remove all mappers.

Definition at line 212 of file fvFieldDecomposer.C.

◆ reset() [1/2]

void reset ( const fvMesh completeMesh)

Reset mappers using information from the complete mesh.

Definition at line 297 of file fvFieldDecomposer.C.

References polyMesh::boundaryMesh(), clear(), forAll, fvPatch::patchSlice(), s(), Foam::sign(), UList< T >::size(), and polyBoundaryMesh::start().

Referenced by fvFieldDecomposer::fvFieldDecomposer().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ reset() [2/2]

void reset ( const List< labelRange > &  boundaryRanges,
const labelUList faceOwner,
const labelUList faceNeigbour 
)

Reset mapper using information about the complete mesh.

Definition at line 221 of file fvFieldDecomposer.C.

References clear(), forAll, fvPatch::patchSlice(), s(), Foam::sign(), and UList< T >::size().

Here is the call graph for this function:

◆ decomposeField() [1/6]

tmp< DimensionedField< Type, volMesh > > decomposeField ( const DimensionedField< Type, volMesh > &  field) const

Decompose internal field.

◆ decomposeField() [2/6]

tmp< GeometricField< Type, fvPatchField, volMesh > > decomposeField ( const GeometricField< Type, fvPatchField, volMesh > &  field,
const bool  allowUnknownPatchFields = false 
) const

Decompose volume field.

◆ decomposeField() [3/6]

tmp< GeometricField< Type, fvsPatchField, surfaceMesh > > decomposeField ( const GeometricField< Type, fvsPatchField, surfaceMesh > &  field) const

Decompose surface field.

◆ decomposeFields()

void decomposeFields ( const PtrList< GeoField > &  fields) const

Decompose list of fields.

Definition at line 369 of file fvFieldDecomposerTemplates.C.

References fields, fld(), and write().

Referenced by fvFieldDecomposer::fieldsCache::privateCache::decompose().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ decomposeField() [4/6]

Foam::tmp< Foam::DimensionedField< Type, Foam::volMesh > > decomposeField ( const DimensionedField< Type, volMesh > &  field) const

Definition at line 42 of file fvFieldDecomposerTemplates.C.

References field(), Foam::New(), IOobject::NO_READ, IOobject::NO_WRITE, fvMesh::thisDb(), objectRegistry::time(), and Time::timeName().

Here is the call graph for this function:

◆ decomposeField() [5/6]

Foam::tmp< Foam::GeometricField< Type, Foam::fvPatchField, Foam::volMesh > > decomposeField ( const GeometricField< Type, fvPatchField, volMesh > &  field,
const bool  allowUnknownPatchFields 
) const

Definition at line 72 of file fvFieldDecomposerTemplates.C.

References Foam::abort(), Foam::FatalError, FatalErrorInFunction, field(), forAll, IOobject::NO_READ, IOobject::NO_WRITE, tmp< T >::ref(), and PtrList< T >::set().

Here is the call graph for this function:

◆ decomposeField() [6/6]

Foam::tmp< Foam::GeometricField< Type, Foam::fvsPatchField, Foam::surfaceMesh > > decomposeField ( const GeometricField< Type, fvsPatchField, surfaceMesh > &  field) const

Definition at line 201 of file fvFieldDecomposerTemplates.C.

References Foam::abort(), Foam::FatalError, FatalErrorInFunction, field(), forAll, IOobject::NO_READ, IOobject::NO_WRITE, p, tmp< T >::ref(), and PtrList< T >::set().

Here is the call graph for this function:

Member Data Documentation

◆ verbose_

int verbose_ = 1
static

Output verbosity when writing.

Definition at line 257 of file fvFieldDecomposer.H.


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