surfaceInterpolate Class Reference

Linearly interpolates volume fields to generate surface fields. More...

Inheritance diagram for surfaceInterpolate:
Collaboration diagram for surfaceInterpolate:

Public Member Functions

 TypeName ("surfaceInterpolate")
 Runtime type information. More...
 
 surfaceInterpolate (const word &name, const Time &runTime, const dictionary &dict)
 Construct for given objectRegistry and dictionary. More...
 
 surfaceInterpolate (const surfaceInterpolate &)=delete
 Disallow default bitwise copy construction. More...
 
virtual ~surfaceInterpolate ()
 Destructor. More...
 
virtual bool read (const dictionary &)
 Read the controls. More...
 
virtual bool execute ()
 Calculate the interpolated fields. More...
 
virtual bool write ()
 Write the interpolated fields. More...
 
void operator= (const surfaceInterpolate &)=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 updateMesh (const mapPolyMesh &mpm)
 Update for changes of mesh. More...
 
virtual void movePoints (const polyMesh &mesh)
 Update for changes of mesh. More...
 
void operator= (const functionObject &)=delete
 Disallow default bitwise assignment. More...
 

Protected Member Functions

template<class Type >
void interpolateFields (PtrList< GeometricField< Type, fvsPatchField, surfaceMesh >> &) 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...
 
PtrList< surfaceScalarFieldssf_
 Locally constructed fields. More...
 
PtrList< surfaceVectorFieldsvf_
 
PtrList< surfaceSphericalTensorFieldsSpheretf_
 
PtrList< surfaceSymmTensorFieldsSymmtf_
 
PtrList< surfaceTensorFieldstf_
 
- 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

Linearly interpolates volume fields to generate surface 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:

surfaceInterpolate1
{
    type        surfaceInterpolate;
    libs        ("libfieldFunctionObjects.so");
    ...
    fields      ((p pInterp)(U UInterp));
}
Usage
Property Description Required Default value
type type name: surfaceInterpolate yes
fields list of fields with corresponding output field names yes
See also
Foam::functionObjects::fvMeshFunctionObject Foam::functionObjects::timeControl
Source files

Definition at line 103 of file surfaceInterpolate.H.

Constructor & Destructor Documentation

◆ surfaceInterpolate() [1/2]

surfaceInterpolate ( 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 51 of file surfaceInterpolate.C.

References Foam::read().

Here is the call graph for this function:

◆ surfaceInterpolate() [2/2]

surfaceInterpolate ( const surfaceInterpolate )
delete

Disallow default bitwise copy construction.

◆ ~surfaceInterpolate()

~surfaceInterpolate ( )
virtual

Destructor.

Definition at line 66 of file surfaceInterpolate.C.

References surfaceInterpolate::read().

Here is the call graph for this function:

Member Function Documentation

◆ interpolateFields()

void interpolateFields ( PtrList< GeometricField< Type, fvsPatchField, surfaceMesh >> &  sflds) const
protected

Definition at line 34 of file surfaceInterpolateTemplates.C.

References Foam::endl(), fld(), forAll, forAllConstIter(), Foam::Info, and Foam::linearInterpolate().

Here is the call graph for this function:

◆ TypeName()

TypeName ( "surfaceInterpolate"  )

Runtime type information.

◆ read()

bool read ( const dictionary dict)
virtual

Read the controls.

Reimplemented from regionFunctionObject.

Definition at line 73 of file surfaceInterpolate.C.

References dictionary::lookup().

Referenced by surfaceInterpolate::~surfaceInterpolate().

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

◆ execute()

bool execute ( )
virtual

Calculate the interpolated fields.

Implements functionObject.

Definition at line 83 of file surfaceInterpolate.C.

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

Here is the call graph for this function:

◆ write()

bool write ( )
virtual

Write the interpolated fields.

Implements functionObject.

Definition at line 106 of file surfaceInterpolate.C.

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

Here is the call graph for this function:

◆ operator=()

void operator= ( const surfaceInterpolate )
delete

Disallow default bitwise assignment.

Member Data Documentation

◆ fieldSet_

List<Tuple2<word, word> > fieldSet_
protected

Fields to process.

Definition at line 112 of file surfaceInterpolate.H.

◆ ssf_

PtrList<surfaceScalarField> ssf_
protected

Locally constructed fields.

Definition at line 115 of file surfaceInterpolate.H.

◆ svf_

PtrList<surfaceVectorField> svf_
protected

Definition at line 116 of file surfaceInterpolate.H.

◆ sSpheretf_

PtrList<surfaceSphericalTensorField> sSpheretf_
protected

Definition at line 117 of file surfaceInterpolate.H.

◆ sSymmtf_

PtrList<surfaceSymmTensorField> sSymmtf_
protected

Definition at line 118 of file surfaceInterpolate.H.

◆ stf_

PtrList<surfaceTensorField> stf_
protected

Definition at line 119 of file surfaceInterpolate.H.


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