Loading...
Searching...
No Matches
cellDecomposer Class Reference
FunctionObjects » Field function objects

Maps input fields from local mesh to a secondary mesh at runtime. More...

#include <cellDecomposer.H>

Inheritance diagram for cellDecomposer:
Inheritance graph
[legend]
Collaboration diagram for cellDecomposer:
Collaboration graph
[legend]

Public Member Functions

 TypeName ("cellDecomposer")
 Runtime type information.
 cellDecomposer (const word &name, const Time &runTime, const dictionary &dict)
 Construct from name, Time and dictionary.
virtual ~cellDecomposer ()=default
 Destructor.
virtual bool read (const dictionary &dict)
 Read the function-object dictionary.
virtual bool execute ()
 Execute the function-object operations.
virtual bool write ()
 Write the function-object results.
template<class Type>
Foam::tmp< Foam::GeometricField< Type, Foam::fvPatchField, Foam::volMesh > > interpolate (const GeometricField< Type, fvPatchField, volMesh > &vf, const fvMesh &sMesh, const labelUList &patchMap, const labelUList &cellMap, const labelUList &faceMap, const bool allowUnmapped) const
Public Member Functions inherited from fvMeshFunctionObject
 TypeName ("fvMeshFunctionObject")
 Runtime type information.
 fvMeshFunctionObject (const word &name, const Time &runTime, const dictionary &dict)
 Construct from Time and dictionary.
 fvMeshFunctionObject (const word &name, const objectRegistry &obr, const dictionary &dict)
 Construct from the region objectRegistry and dictionary.
virtual ~fvMeshFunctionObject ()=default
 Destructor.
Public Member Functions inherited from regionFunctionObject
 TypeName ("regionFunctionObject")
 Runtime type information.
 regionFunctionObject (const word &name, const Time &runTime, const dictionary &dict)
 Construct from Time and dictionary.
 regionFunctionObject (const word &name, const objectRegistry &obr, const dictionary &dict)
 Construct from the region objectRegistry and dictionary.
virtual ~regionFunctionObject ()=default
 Destructor.
template<class ObjectType>
const ObjectType * lookupObjectPtr (const word &fieldName) const
 Deprecated(2018-10).
template<class ObjectType>
ObjectType * lookupObjectRefPtr (const word &fieldName) const
 Deprecated(2018-10).
Public Member Functions inherited from stateFunctionObject
 stateFunctionObject (const word &name, const Time &runTime)
 Construct from components.
virtual ~stateFunctionObject ()=default
 Destructor.
dictionary & propertyDict ()
 Return access to the property dictionary.
bool foundProperty (const word &entryName) const
 Return true if the property exists.
void clearTrigger ()
 Remove the trigger index from the properties.
label getTrigger () const
 Get the current trigger index.
bool setTrigger (const label triggeri)
 Set new trigger index.
bool getDict (const word &entryName, dictionary &dict) const
 Set dictionary, return true if set.
bool getObjectDict (const word &objectName, const word &entryName, dictionary &dict) const
 Set dictionary from named object, return true if set.
template<class Type>
Type getProperty (const word &entryName, const Type &defaultValue=Type(Zero)) const
 Retrieve generic property.
template<class Type>
bool getProperty (const word &entryName, Type &value) const
 Set generic property, return true if set.
template<class Type>
void setProperty (const word &entryName, const Type &value)
 Add generic property.
template<class Type>
Type getObjectProperty (const word &objectName, const word &entryName, const Type &defaultValue=Type(Zero)) const
 Retrieve generic property from named object.
template<class Type>
bool getObjectProperty (const word &objectName, const word &entryName, Type &value) const
 Set generic property from named object, return true if set.
template<class Type>
void setObjectProperty (const word &objectName, const word &entryName, const Type &value)
 Add generic property from named object.
bool getObjectResultDict (const word &objectName, dictionary &dict) const
template<class Type>
void setResult (const word &entryName, const Type &value)
 Add result.
template<class Type>
void setObjectResult (const word &objectName, const word &entryName, const Type &value)
 Add result from named object.
template<class Type>
Type getResult (const word &entryName, const Type &defaultValue=Type(Zero)) const
 Retrieve result.
template<class Type>
Type getObjectResult (const word &objectName, const word &entryName, const Type &defaultValue=Type(Zero)) const
 Retrieve result from named object.
template<class Type>
bool getObjectResult (const word &objectName, const word &entryName, Type &value) const
 Set result from named object, return true if set.
word resultType (const word &entryName) const
 Retrieve the result type.
word objectResultType (const word &objectName, const word &entryName) const
 Return the type of result.
wordList objectResultEntries () const
 Retrieve the result entries.
wordList objectResultEntries (const word &objectName) const
 Return result entries for named object.
void writeResultEntries (Ostream &os) const
 Write the results entries for all objects to stream.
void writeResultEntries (const word &objectName, Ostream &os) const
 Write the results entries for named object to stream.
void writeAllResultEntries (Ostream &os) const
 Write the results entries for all objects to stream.
Public Member Functions inherited from timeFunctionObject
 timeFunctionObject (const word &name, const Time &runTime)
 Construct from Time.
virtual ~timeFunctionObject ()=default
 Destructor.
const Time & time () const
 Return time database.
objectRegistry & storedObjects ()
 Write access to the output objects ("functionObjectObjects") registered on Time.
const objectRegistry & storedObjects () const
 Const access to the output objects ("functionObjectObjects") registered on Time.
Public Member Functions inherited from functionObject
 declareRunTimeSelectionTable (autoPtr, functionObject, dictionary,(const word &name, const Time &runTime, const dictionary &dict),(name, runTime, dict))
 functionObject (const word &name, const bool withNamePrefix=defaultUseNamePrefix)
 Construct from components.
autoPtr< functionObject > clone () const
 Return clone.
virtual ~functionObject ()=default
 Destructor.
virtual const word & type () const =0
 Runtime type information.
const word & name () const noexcept
 Return the name of this functionObject.
bool useNamePrefix () const noexcept
 Return the flag for adding a scoping name prefix.
bool useNamePrefix (bool on) noexcept
 Modify the flag for adding a scoping name prefix.
virtual bool execute (const label subIndex)
 Execute using the specified subIndex.
virtual bool end ()
 Called when Time::run() determines that the time-loop exits.
virtual bool adjustTimeStep ()
 Called at the end of Time::adjustDeltaT() if adjustTime is true.
virtual bool filesModified () const
 Did any file get changed during execution?
virtual void updateMesh (const mapPolyMesh &mpm)
 Update for changes of mesh.
virtual void movePoints (const polyMesh &mesh)
 Update for changes of mesh.

Additional Inherited Members

Static Public Member Functions inherited from functionObject
static autoPtr< functionObject > New (const word &name, const Time &runTime, const dictionary &dict)
 Select from dictionary, based on its "type" entry.
Public Attributes inherited from functionObject
bool log
 Flag to write log into Info.
Static Public Attributes inherited from functionObject
static int debug
 Flag to execute debug content.
static bool postProcess
 Global post-processing mode switch.
static bool defaultUseNamePrefix
 Global default for useNamePrefix.
static word outputPrefix
 Directory prefix.
Protected Member Functions inherited from fvMeshFunctionObject
 fvMeshFunctionObject (const fvMeshFunctionObject &)=delete
 No copy construct.
void operator= (const fvMeshFunctionObject &)=delete
 No copy assignment.
Protected Member Functions inherited from regionFunctionObject
virtual const objectRegistry & obr () const
 The region or sub-region registry being used.
template<class ObjectType>
bool foundObject (const word &fieldName) const
 Find object (eg, a field) in the (sub) objectRegistry.
template<class ObjectType>
const ObjectType * cfindObject (const word &fieldName) const
 Return const pointer to the object (eg, a field) in the (sub) objectRegistry.
template<class ObjectType>
const ObjectType * findObject (const word &fieldName) const
 Return const pointer to the object (eg, a field) in the (sub) objectRegistry.
template<class ObjectType>
ObjectType * findObject (const word &fieldName)
 Return non-const pointer to the object of the given Type, (sub) objectRegistry.
template<class ObjectType>
ObjectType * getObjectPtr (const word &fieldName) const
 Return non-const pointer to the object of the given Type, using a const-cast to have it behave like a mutable.
template<class ObjectType>
const ObjectType & lookupObject (const word &fieldName) const
 Lookup and return object (eg, a field) from the (sub) objectRegistry.
template<class ObjectType>
ObjectType & lookupObjectRef (const word &fieldName) const
 Lookup and return object (eg, a field) from the (sub) objectRegistry.
template<class ObjectType>
bool store (word &fieldName, const tmp< ObjectType > &tfield, bool cacheable=false)
 Store the field in the (sub) objectRegistry under the given name.
template<class ObjectType>
bool storeInDb (const word &fieldName, const tmp< ObjectType > &tfield, const objectRegistry &obr)
 Store the field in an optional objectRegistry under the given name.
bool writeObject (const word &fieldName)
 Write field if present in the (sub) objectRegistry.
bool clearObject (const word &fieldName)
 Clear field from the (sub) objectRegistry if present.
void clearObjects (const wordList &objNames)
 Clear fields from the (sub) objectRegistry if present.
 regionFunctionObject (const regionFunctionObject &)=delete
 No copy construct.
void operator= (const regionFunctionObject &)=delete
 No copy assignment.
Protected Member Functions inherited from stateFunctionObject
const functionObjects::properties & stateDict () const
 Return a const reference to the state dictionary.
functionObjects::properties & stateDict ()
 Return non-const access to the state dictionary.
 stateFunctionObject (const stateFunctionObject &)=delete
 No copy construct.
void operator= (const stateFunctionObject &)=delete
 No copy assignment.
Protected Member Functions inherited from timeFunctionObject
void clearOutputObjects (const wordList &objNames)
 Remove specified items from "functionObjectObjects".
 timeFunctionObject (const timeFunctionObject &)=delete
 No copy construct.
void operator= (const timeFunctionObject &)=delete
 No copy assignment.
Protected Member Functions inherited from functionObject
word scopedName (const word &name) const
 Return a scoped (prefixed) name.
Protected Attributes inherited from fvMeshFunctionObject
const fvMesh & mesh_
 Reference to the fvMesh.
Protected Attributes inherited from regionFunctionObject
word subRegistryName_
 Name for alternative object registry.
const objectRegistry & obr_
 Reference to the region objectRegistry.
const objectRegistry * obrPtr_
 Pointer to alternative (eg, sub-region) objectRegistry.
Protected Attributes inherited from timeFunctionObject
const Time & time_
 Reference to the time database.

Detailed Description

Maps input fields from local mesh to a secondary mesh at runtime.

The secondary mesh gets created on-the-fly by decomposing the current mesh.

The decomposition can be full (all cells) or partial (a cellSet). The decomposition can be done in different ways, see the decomposeType description below.

The mapping is done via nearest-neighbour interpolation. The mapped fields are written to the time directory of the original mesh. The mapped fields have the same name as the input fields, but with a _decomposed suffix.

The mapping tolerates cells that cannot be mapped, e.g. if the cell centre of a cell in the decomposed mesh lies outside the original mesh. The unmapped cells get a value of zero, and a warning is issued.

Operands:

Operand Type Location
input {vol,surface}<Type>Field <time>/inputFields
output file - -
output field {vol,surface}<Type>Field <time>/outputField

where Type can be one of: Scalar, Vector, SphericalTensor, SymmTensor, or Tensor.

Usage
Minimal example by using system/controlDict.functions: 
cellDecomposerFO
{
    // Mandatory entries
    type            cellDecomposer;
    libs            (fieldFunctionObjects);
    fields          (<wordRes>);  // (<field1> <field2> ... <fieldN>);
    mapRegion       <word>;       // myTetMesh;
    decomposeType   <word>;       // polyhedral;
    selectionMode   <word>;       //all;

    // Inherited entries
    ...
}

where the entries mean:

Property Description Type Reqd Deflt
type Type name: cellDecomposer word yes -
libs Library name: fieldFunctionObjects word yes -
fields Names of operand fields wordRes yes -
cacheDecomposition Cache the generated mesh bool no false
mapRegion Name of region to map to word yes -
decomposeType How to decompose cells word yes -
selectionMode How to select cells (see fvOption)word yes -

The inherited entries are elaborated in:

decomposeType:

  • faceCentre : decompose cells into tets using face centre and cell centre. (hex becomes 6*4 tets)
  • faceDiagonal : decompose cells into tets using face diagonal, similar to implicit decomposition inside lagrangian tracking. (hex becomes 6*2 tets)
  • pyramid : keep faces intact but create (polygonal-base) pyramids using cell centre (hex becomes 6 pyramids)
  • faceDiagonalQuads : like faceDiagonal but split faces into quads and triangles instead of just triangles
  • polyhedral : like faceDiagonalQuads but only decompose non-hex/prism/tet cells in selected set. Used to convert polyhedral mesh into 'simple' mesh.

Note: cacheDecomposition will

  • keep the mesh and maps
  • not update the points on the mesh It will not be correct if the selectionMode varies over time or if the geometry of the mapping is used (e.g. old face areas/volumes).

The inherited entries are elaborated in:

See also
Source files

Definition at line 206 of file cellDecomposer.H.

Constructor & Destructor Documentation

◆ cellDecomposer()

cellDecomposer ( const word & name,
const Time & runTime,
const dictionary & dict )

Construct from name, Time and dictionary.

Definition at line 314 of file cellDecomposer.C.

References dict, fvMeshFunctionObject::fvMeshFunctionObject(), Foam::name(), read(), and runTime.

Here is the call graph for this function:

◆ ~cellDecomposer()

virtual ~cellDecomposer ( )
virtualdefault

Destructor.

References dict.

Member Function Documentation

◆ TypeName()

TypeName ( "cellDecomposer" )

Runtime type information.

References dict, Foam::name(), and runTime.

Here is the call graph for this function:

◆ read()

bool read ( const dictionary & dict)
virtual

Read the function-object dictionary.

Reimplemented from regionFunctionObject.

Definition at line 330 of file cellDecomposer.C.

References dict, Foam::GlobalIOList< Tuple2< scalar, vector > >::typeName, and functionObject::read().

Referenced by cellDecomposer().

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

◆ execute()

bool execute ( )
virtual

Execute the function-object operations.

Could update points (on tetMesh and mapper). Gives AMI issues currently.

fvMesh& mapRegion = const_cast<fvMesh&>(*mapRegionPtr); const auto& cellToPoint = tetDecompPtr_().cellToPoint(); const auto& faceToPoint = tetDecompPtr_().faceToPoint(); pointField newPoints(mapRegion.nPoints()); forAll(cellToPoint, celli) { const label pti = cellToPoint[celli]; if (pti != -1) { newPoints[pti] = mesh_.cellCentres()[celli]; } } forAll(faceToPoint, facei) { const label pti = faceToPoint[facei]; if (pti != -1) { newPoints[pti] = mesh_.faceCentres()[facei]; } } mapRegion.movePoints(newPoints);

Implements functionObject.

Definition at line 348 of file cellDecomposer.C.

References Foam::endl(), objectRegistry::erase(), Log, fvMeshFunctionObject::mesh_, name, Foam::nl, and Foam::type().

Here is the call graph for this function:

◆ write()

bool write ( )
virtual

Write the function-object results.

Implements functionObject.

Definition at line 418 of file cellDecomposer.C.

References Foam::endl(), Log, name, Foam::nl, and Foam::type().

Here is the call graph for this function:

◆ interpolate()

template<class Type>
Foam::tmp< Foam::GeometricField< Type, Foam::fvPatchField, Foam::volMesh > > interpolate ( const GeometricField< Type, fvPatchField, volMesh > & vf,
const fvMesh & sMesh,
const labelUList & patchMap,
const labelUList & cellMap,
const labelUList & faceMap,
const bool allowUnmapped ) const

Definition at line 53 of file cellDecomposerTemplates.C.

References fvMesh::boundary(), GeometricField< Type, PatchField, GeoMesh >::boundaryField(), fvPatchFieldBase::calculatedType(), DimensionedField< Type, GeoMesh >::dimensions(), Foam::faceMap(), fld(), forAll, DirectFieldMapper< FieldMapperType >::hasUnmapped(), DimensionedField< Type, GeoMesh >::mesh(), IOobject::name(), fvPatchField< Type >::New(), Foam::New(), IOobjectOption::NO_READ, IOobjectOption::NO_WRITE, DimensionedField< Type, volMesh >::null(), DimensionedField< Type, GeoMesh >::oriented(), GeometricField< Type, PatchField, GeoMesh >::primitiveField(), PtrList< T >::set(), fvPatch::size(), UList< T >::size(), fvPatch::start(), fvMesh::time(), and Time::timeName().

Here is the call graph for this function:
The documentation for this class was generated from the following files: