nearWallFields Class Reference

Samples near-patch volume fields. More...

Inheritance diagram for nearWallFields:
Collaboration diagram for nearWallFields:

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 wordtype () 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)
 Construct from components. More...
 
autoPtr< functionObjectclone () const
 Return clone. More...
 
 functionObject (const functionObject &)=delete
 Disallow default bitwise copy construction. More...
 
virtual ~functionObject ()
 Destructor. More...
 
const wordname () 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 timeToNextWrite ()
 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...
 
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< GeometricField< Type, fvPatchField, volMesh >> &) const
 
template<class Type >
void sampleBoundaryField (const interpolationCellPoint< Type > &interpolator, GeometricField< Type, fvPatchField, volMesh > &fld) const
 Override boundary fields with sampled values. More...
 
template<class Type >
void sampleFields (PtrList< GeometricField< Type, fvPatchField, volMesh >> &) 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< wordfieldMap_
 From original field to sampled result. More...
 
HashTable< wordreverseFieldMap_
 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< distributionMapgetPatchDataMapPtr_
 Map from cell based data back to patch based data. More...
 
PtrList< volScalarFieldvsf_
 
PtrList< volVectorFieldvvf_
 
PtrList< volSphericalTensorFieldvSpheretf_
 
PtrList< volSymmTensorFieldvSymmtf_
 
PtrList< volTensorFieldvtf_
 
- Protected Attributes inherited from fvMeshFunctionObject
const fvMeshmesh_
 Reference to the fvMesh. More...
 
- Protected Attributes inherited from regionFunctionObject
const Timetime_
 Reference to the Time. More...
 
const objectRegistryobr_
 Reference to the region objectRegistry. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from functionObject
static autoPtr< functionObjectNew (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...
 

Detailed Description

Samples near-patch volume fields.

Fields are stored

  • every time step the field is updated with new values
  • at output it writes the fields

This functionObject can either be used

  • to calculate a new field as a post-processing step or
  • since the fields are registered, used in another functionObject

Example of function object specification:

nearWallFields1
{
    type        nearWallFields;
    libs        ("libfieldFunctionObjects.so");

    writeControl writeTime;

    fields
    (
        (p pNear)
        (U UNear)
    );

    patches     (movingWall);

    distance    0.13;
}
Usage
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
See also
Foam::functionObjects::fvMeshFunctionObject
Source files

Definition at line 119 of file nearWallFields.H.

Constructor & Destructor Documentation

◆ nearWallFields() [1/2]

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 189 of file nearWallFields.C.

References Foam::read().

Referenced by nearWallFields::calcAddressing().

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

◆ nearWallFields() [2/2]

nearWallFields ( const nearWallFields )
delete

Disallow default bitwise copy construction.

◆ ~nearWallFields()

~nearWallFields ( )
virtual

Destructor.

Definition at line 204 of file nearWallFields.C.

References DebugInFunction, and Foam::endl().

Here is the call graph for this function:

Member Function Documentation

◆ calcAddressing()

◆ createFields()

void createFields ( PtrList< GeometricField< Type, fvPatchField, volMesh >> &  sflds) const
protected

Definition at line 32 of file nearWallFieldsTemplates.C.

References Foam::endl(), fld(), forAllConstIter, Log, and nearWallFields::sampleBoundaryField().

Here is the call graph for this function:

◆ sampleBoundaryField()

void sampleBoundaryField ( const interpolationCellPoint< Type > &  interpolator,
GeometricField< Type, fvPatchField, volMesh > &  fld 
) const
protected

Override boundary fields with sampled values.

Definition at line 85 of file nearWallFieldsTemplates.C.

References GeometricField< Type, PatchField, GeoMesh >::boundaryFieldRef(), forAll, forAllConstIter, interpolationCellPoint< Type >::interpolate(), patchi, nearWallFields::sampleFields(), and List< Type >::size().

Referenced by nearWallFields::createFields().

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

◆ sampleFields()

void sampleFields ( PtrList< GeometricField< Type, fvPatchField, volMesh >> &  sflds) const
protected

Definition at line 135 of file nearWallFieldsTemplates.C.

References fld(), and forAll.

Referenced by nearWallFields::sampleBoundaryField().

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

◆ TypeName()

TypeName ( "nearWallFields"  )

Runtime type information.

◆ read()

bool read ( const dictionary dict)
virtual

Read the controls.

Reimplemented from regionFunctionObject.

Definition at line 212 of file nearWallFields.C.

References List< T >::clear(), Foam::endl(), forAll, Log, dictionary::lookup(), Foam::name(), regionFunctionObject::read(), and Foam::type().

Here is the call graph for this function:

◆ fields()

Foam::wordList fields ( ) const
virtual

Return the list of fields required.

Implements functionObject.

Definition at line 256 of file nearWallFields.C.

References fields, and forAll.

◆ execute()

bool execute ( )
virtual

Calculate the near-wall fields.

Implements functionObject.

Definition at line 269 of file nearWallFields.C.

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

Here is the call graph for this function:

◆ write()

bool write ( )
virtual

Write the near-wall fields.

Implements functionObject.

Definition at line 310 of file nearWallFields.C.

References DebugInFunction, Foam::endl(), forAll, and Log.

Here is the call graph for this function:

◆ operator=()

void operator= ( const nearWallFields )
delete

Disallow default bitwise assignment.

Member Data Documentation

◆ fieldSet_

List<Tuple2<word, word> > fieldSet_
protected

Fields to process.

Definition at line 130 of file nearWallFields.H.

◆ patchSet_

labelHashSet patchSet_
protected

Patches to sample.

Definition at line 133 of file nearWallFields.H.

◆ distance_

scalar distance_
protected

Distance away from wall.

Definition at line 136 of file nearWallFields.H.

◆ fieldMap_

HashTable<word> fieldMap_
protected

From original field to sampled result.

Definition at line 139 of file nearWallFields.H.

◆ reverseFieldMap_

HashTable<word> reverseFieldMap_
protected

From resulting back to original field.

Definition at line 142 of file nearWallFields.H.

◆ cellToWalls_

labelListList cellToWalls_
protected

From cell to seed patch faces.

Definition at line 148 of file nearWallFields.H.

◆ cellToSamples_

List<List<point> > cellToSamples_
protected

From cell to tracked end point.

Definition at line 151 of file nearWallFields.H.

◆ getPatchDataMapPtr_

autoPtr<distributionMap> getPatchDataMapPtr_
protected

Map from cell based data back to patch based data.

Definition at line 154 of file nearWallFields.H.

◆ vsf_

PtrList<volScalarField> vsf_
protected

Definition at line 159 of file nearWallFields.H.

◆ vvf_

PtrList<volVectorField> vvf_
protected

Definition at line 160 of file nearWallFields.H.

◆ vSpheretf_

PtrList<volSphericalTensorField> vSpheretf_
protected

Definition at line 161 of file nearWallFields.H.

◆ vSymmtf_

PtrList<volSymmTensorField> vSymmtf_
protected

Definition at line 162 of file nearWallFields.H.

◆ vtf_

PtrList<volTensorField> vtf_
protected

Definition at line 163 of file nearWallFields.H.


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