Samples near-patch volume fields. More...
Public Member Functions | |
TypeName ("nearWallFields") | |
Runtime type information. More... | |
nearWallFields (const word &name, const Time &runTime, const dictionary &dict) | |
Construct for given objectRegistry and dictionary. More... | |
nearWallFields (const nearWallFields &)=delete | |
Disallow default bitwise copy construction. More... | |
virtual | ~nearWallFields () |
Destructor. More... | |
virtual bool | read (const dictionary &) |
Read the controls. More... | |
virtual wordList | fields () const |
Return the list of fields required. More... | |
virtual bool | execute () |
Calculate the near-wall fields. More... | |
virtual bool | write () |
Write the near-wall fields. More... | |
void | operator= (const nearWallFields &)=delete |
Disallow default bitwise assignment. More... | |
Public Member Functions inherited from fvMeshFunctionObject | |
TypeName ("fvMeshFunctionObject") | |
Runtime type information. More... | |
fvMeshFunctionObject (const word &name, const Time &runTime, const dictionary &dict) | |
Construct from Time and dictionary. More... | |
fvMeshFunctionObject (const word &name, const objectRegistry &obr, const dictionary &dict) | |
Construct from the region objectRegistry and dictionary. More... | |
fvMeshFunctionObject (const fvMeshFunctionObject &)=delete | |
Disallow default bitwise copy construction. More... | |
virtual | ~fvMeshFunctionObject () |
Destructor. More... | |
void | operator= (const fvMeshFunctionObject &)=delete |
Disallow default bitwise assignment. More... | |
Public Member Functions inherited from regionFunctionObject | |
TypeName ("regionFunctionObject") | |
Runtime type information. More... | |
regionFunctionObject (const word &name, const Time &runTime, const dictionary &dict) | |
Construct from Time and dictionary. More... | |
regionFunctionObject (const word &name, const objectRegistry &obr, const dictionary &dict) | |
Construct from the region objectRegistry and dictionary. More... | |
regionFunctionObject (const regionFunctionObject &)=delete | |
Disallow default bitwise copy construction. More... | |
virtual | ~regionFunctionObject () |
Destructor. More... | |
void | operator= (const regionFunctionObject &)=delete |
Disallow default bitwise assignment. More... | |
Public Member Functions inherited from functionObject | |
ClassName ("functionObject") | |
virtual const word & | type () const =0 |
Runtime type information. More... | |
declareRunTimeSelectionTable (autoPtr, functionObject, dictionary,(const word &name, const Time &runTime, const dictionary &dict),(name, runTime, dict)) | |
functionObject (const word &name, const Time &runTime) | |
Construct from components. More... | |
autoPtr< functionObject > | clone () const |
Return clone. More... | |
functionObject (const functionObject &)=delete | |
Disallow default bitwise copy construction. More... | |
virtual | ~functionObject () |
Destructor. More... | |
const word & | name () const |
Return the name of this functionObject. More... | |
virtual bool | executeAtStart () const |
Return true if the functionObject should be executed at the start. More... | |
virtual bool | end () |
Called when Time::run() determines that the time-loop exits. More... | |
virtual scalar | timeToNextAction () |
Called by Time::adjustTimeStep(). Allows the functionObject to. More... | |
virtual void | movePoints (const polyMesh &mesh) |
Update topology using the given map. More... | |
virtual void | topoChange (const polyTopoChangeMap &map) |
Update topology using the given map. More... | |
virtual void | mapMesh (const polyMeshMap &) |
Update from another mesh using the given map. More... | |
virtual void | distribute (const polyDistributionMap &) |
Redistribute or update using the given distribution map. More... | |
void | operator= (const functionObject &)=delete |
Disallow default bitwise assignment. More... | |
Protected Member Functions | |
void | calcAddressing () |
Calculate addressing from cells back to patch faces. More... | |
template<class Type > | |
void | createFields (PtrList< VolField< Type >> &) const |
template<class Type > | |
void | sampleBoundaryField (const interpolationCellPoint< Type > &interpolator, VolField< Type > &fld) const |
Override boundary fields with sampled values. More... | |
template<class Type > | |
void | sampleFields (PtrList< VolField< Type >> &) const |
Protected Member Functions inherited from regionFunctionObject | |
template<class ObjectType > | |
bool | foundObject (const word &fieldName) const |
Find field in the objectRegistry. More... | |
template<class ObjectType > | |
void | cannotFindObject (const word &fieldName) |
Prints a warning message that fieldName cannot be found. More... | |
void | cannotFindObject (const word &fieldName) |
Prints a warning message that fieldName cannot be found. More... | |
template<class ObjectType > | |
const ObjectType & | lookupObject (const word &fieldName) const |
Lookup object from the objectRegistry. More... | |
template<class ObjectType > | |
ObjectType & | lookupObjectRef (const word &fieldName) |
Lookup non-const object reference from the objectRegistry. More... | |
template<class ObjectType > | |
bool | store (const tmp< ObjectType > &tfield) |
Store the given field in the objectRegistry. More... | |
template<class ObjectType > | |
bool | store (const word &fieldName, const tmp< ObjectType > &tfield, bool cacheable=false) |
Store the given field in the objectRegistry under the given name. More... | |
bool | writeObject (const word &fieldName) |
Write field if present in objectRegistry. More... | |
bool | clearObject (const word &fieldName) |
Clear field from the objectRegistry if present. More... | |
Protected Attributes | |
List< Tuple2< word, word > > | fieldSet_ |
Fields to process. More... | |
labelHashSet | patchSet_ |
Patches to sample. More... | |
scalar | distance_ |
Distance away from wall. More... | |
HashTable< word > | fieldMap_ |
From original field to sampled result. More... | |
HashTable< word > | reverseFieldMap_ |
From resulting back to original field. More... | |
labelListList | cellToWalls_ |
From cell to seed patch faces. More... | |
List< List< point > > | cellToSamples_ |
From cell to tracked end point. More... | |
autoPtr< distributionMap > | getPatchDataMapPtr_ |
Map from cell based data back to patch based data. More... | |
PtrList< volScalarField > | vsf_ |
PtrList< volVectorField > | vvf_ |
PtrList< volSphericalTensorField > | vSpheretf_ |
PtrList< volSymmTensorField > | vSymmtf_ |
PtrList< volTensorField > | vtf_ |
Protected Attributes inherited from fvMeshFunctionObject | |
const fvMesh & | mesh_ |
Reference to the fvMesh. More... | |
Protected Attributes inherited from regionFunctionObject | |
const objectRegistry & | obr_ |
Reference to the region objectRegistry. More... | |
Protected Attributes inherited from functionObject | |
const Time & | time_ |
Reference to time. More... | |
Additional Inherited Members | |
Static Public Member Functions inherited from functionObject | |
static autoPtr< functionObject > | New (const word &name, const Time &, const dictionary &) |
Select from dictionary, based on its "type" entry. More... | |
Public Attributes inherited from functionObject | |
Switch | log |
Switch write log to Info. More... | |
Switch | executeAtStart_ |
Switch write log to Info. More... | |
Static Public Attributes inherited from functionObject | |
static bool | postProcess |
Global post-processing mode switch. More... | |
Samples near-patch volume fields.
Fields are stored
This functionObject can either be used
Example of function object specification:
nearWallFields1 { type nearWallFields; libs ("libfieldFunctionObjects.so"); writeControl writeTime; fields ( (p pNear) (U UNear) ); patches (movingWall); distance 0.13; }
Property | Description | Required | Default value |
---|---|---|---|
type | type name: nearWallFields | yes | |
fields | list of fields with corresponding output field names | yes | |
patches | list of patches to sample | yes | |
distance | distance from patch to sample | yes |
Definition at line 119 of file nearWallFields.H.
nearWallFields | ( | const word & | name, |
const Time & | runTime, | ||
const dictionary & | dict | ||
) |
Construct for given objectRegistry and dictionary.
Allow the possibility to load fields from files
Definition at line 185 of file nearWallFields.C.
References dict, and nearWallFields::read().
|
delete |
Disallow default bitwise copy construction.
|
virtual |
Destructor.
Definition at line 201 of file nearWallFields.C.
References DebugInFunction, and Foam::endl().
|
protected |
Calculate addressing from cells back to patch faces.
Definition at line 47 of file nearWallFields.C.
References fvMesh::boundary(), nearWallFields::cellToSamples_, nearWallFields::cellToWalls_, fvPatch::Cf(), DebugInFunction, cloud::defaultName, nearWallFields::distance_, Foam::endl(), fvPatch::faceCells(), forAll, forAllConstIter, nearWallFields::getPatchDataMapPtr_, InfoInFunction, fvMeshFunctionObject::mesh_, OFstream::name(), dimensioned< Type >::name(), primitiveMesh::nCells(), fvPatch::nf(), p, patchi, nearWallFields::patchSet_, Time::path(), particle::position(), List< T >::setSize(), UPtrList< T >::size(), globalIndex::size(), functionObject::time_, globalIndex::toGlobal(), and OBJstream::write().
Definition at line 31 of file nearWallFieldsTemplates.C.
References Foam::endl(), nearWallFields::fieldMap_, fld(), forAllConstIter, HashTable< T, Key, Hash >::found(), Log, objectRegistry::lookupClass(), fvMeshFunctionObject::mesh_, dimensioned< Type >::name(), regionFunctionObject::obr_, and functionObject::time_.
|
protected |
Override boundary fields with sampled values.
Definition at line 82 of file nearWallFieldsTemplates.C.
References fld(), forAll, forAllConstIter, interpolationCellPoint< Type >::interpolate(), patchi, and List< T >::size().
TypeName | ( | "nearWallFields" | ) |
Runtime type information.
|
virtual |
Read the controls.
Reimplemented from regionFunctionObject.
Definition at line 209 of file nearWallFields.C.
References dict, Foam::endl(), forAll, Log, Foam::name(), regionFunctionObject::read(), and Foam::type().
Referenced by nearWallFields::nearWallFields().
|
virtual |
Return the list of fields required.
Implements functionObject.
Definition at line 253 of file nearWallFields.C.
|
virtual |
Calculate the near-wall fields.
Implements functionObject.
Definition at line 266 of file nearWallFields.C.
References DebugInFunction, Foam::endl(), Log, Foam::name(), Foam::nl, and Foam::type().
|
virtual |
Write the near-wall fields.
Implements functionObject.
Definition at line 307 of file nearWallFields.C.
References DebugInFunction, Foam::endl(), forAll, and Log.
|
delete |
Disallow default bitwise assignment.
Fields to process.
Definition at line 130 of file nearWallFields.H.
|
protected |
Patches to sample.
Definition at line 133 of file nearWallFields.H.
Referenced by nearWallFields::calcAddressing().
|
protected |
Distance away from wall.
Definition at line 136 of file nearWallFields.H.
Referenced by nearWallFields::calcAddressing().
From original field to sampled result.
Definition at line 139 of file nearWallFields.H.
Referenced by nearWallFields::createFields().
From resulting back to original field.
Definition at line 142 of file nearWallFields.H.
|
protected |
From cell to seed patch faces.
Definition at line 148 of file nearWallFields.H.
Referenced by nearWallFields::calcAddressing().
From cell to tracked end point.
Definition at line 151 of file nearWallFields.H.
Referenced by nearWallFields::calcAddressing().
|
protected |
Map from cell based data back to patch based data.
Definition at line 154 of file nearWallFields.H.
Referenced by nearWallFields::calcAddressing().
|
protected |
Definition at line 159 of file nearWallFields.H.
|
protected |
Definition at line 160 of file nearWallFields.H.
|
protected |
Definition at line 161 of file nearWallFields.H.
|
protected |
Definition at line 162 of file nearWallFields.H.
|
protected |
Definition at line 163 of file nearWallFields.H.