Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
surfaceInterpolateFields Class Reference

This function object linearly interpolates volume fields to generate surface fields. More...

Collaboration diagram for surfaceInterpolateFields:
Collaboration graph
[legend]

Public Member Functions

 TypeName ("surfaceInterpolateFields")
 Runtime type information. More...
 
 surfaceInterpolateFields (const word &name, const objectRegistry &, const dictionary &, const bool loadFromFiles=false)
 Construct for given objectRegistry and dictionary. More...
 
virtual ~surfaceInterpolateFields ()
 Destructor. More...
 
virtual const wordname () const
 Return name of the surfaceInterpolateFields object. More...
 
virtual void read (const dictionary &)
 Read the field min/max data. More...
 
virtual void execute ()
 Execute, currently does nothing. More...
 
virtual void end ()
 Execute at the final time-loop, currently does nothing. More...
 
virtual void timeSet ()
 Called when time was set at the end of the Time::operator++. More...
 
virtual void write ()
 Write. More...
 
virtual void updateMesh (const mapPolyMesh &)
 Update for changes of mesh. More...
 
virtual void movePoints (const polyMesh &)
 Update for changes of mesh. More...
 

Protected Member Functions

 surfaceInterpolateFields (const surfaceInterpolateFields &)
 Disallow default bitwise copy construct. More...
 
void operator= (const surfaceInterpolateFields &)
 Disallow default bitwise assignment. More...
 
template<class Type >
void interpolateFields (PtrList< GeometricField< Type, fvsPatchField, surfaceMesh > > &) const
 

Protected Attributes

word name_
 Name of this set of surfaceInterpolateFields object. More...
 
const objectRegistryobr_
 
bool active_
 on/off switch More...
 
List< Tuple2< word, word > > fieldSet_
 Fields to process. More...
 
PtrList< surfaceScalarFieldssf_
 Locally constructed fields. More...
 
PtrList< surfaceVectorFieldsvf_
 
PtrList< surfaceSphericalTensorFieldsSpheretf_
 
PtrList< surfaceSymmTensorFieldsSymmtf_
 
PtrList< surfaceTensorFieldstf_
 

Detailed Description

This function object linearly interpolates volume fields to generate surface fields.

Group grpFieldFunctionObjects

Fields are stored

This functionObject can either be used

Example of function object specification:

surfaceInterpolateFields1
{
    type        surfaceInterpolateFields;
    functionObjectLibs ("libfieldFunctionObjects.so");
    ...
    fields      ((p pNear)(U UNear));
}


Function object usage

Property Description Required Default value
type type name: nearWallFields yes
fields list of fields with correspoding output field names yes
See also
Foam::functionObject Foam::OutputFilterFunctionObject
Source files

Definition at line 105 of file surfaceInterpolateFields.H.

Constructor & Destructor Documentation

Disallow default bitwise copy construct.

surfaceInterpolateFields ( const word name,
const objectRegistry obr,
const dictionary dict,
const bool  loadFromFiles = false 
)

Construct for given objectRegistry and dictionary.

Allow the possibility to load fields from files

Definition at line 39 of file surfaceInterpolateFields.C.

References Foam::endl(), Foam::read(), and WarningIn.

Here is the call graph for this function:

Destructor.

Definition at line 76 of file surfaceInterpolateFields.C.

Member Function Documentation

void operator= ( const surfaceInterpolateFields )
protected

Disallow default bitwise assignment.

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

Definition at line 34 of file surfaceInterpolateFieldsTemplates.C.

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

Here is the call graph for this function:

TypeName ( "surfaceInterpolateFields"  )

Runtime type information.

virtual const word& name ( ) const
inlinevirtual
void read ( const dictionary dict)
virtual

Read the field min/max data.

Definition at line 82 of file surfaceInterpolateFields.C.

References dictionary::lookup().

Referenced by surfaceInterpolateFields::name().

Here is the call graph for this function:

Here is the caller graph for this function:

void execute ( )
virtual

Execute, currently does nothing.

Definition at line 91 of file surfaceInterpolateFields.C.

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

Referenced by surfaceInterpolateFields::name().

Here is the call graph for this function:

Here is the caller graph for this function:

void end ( )
virtual

Execute at the final time-loop, currently does nothing.

Definition at line 115 of file surfaceInterpolateFields.C.

Referenced by surfaceInterpolateFields::name().

Here is the caller graph for this function:

void timeSet ( )
virtual

Called when time was set at the end of the Time::operator++.

Definition at line 124 of file surfaceInterpolateFields.C.

Referenced by surfaceInterpolateFields::name().

Here is the caller graph for this function:

void write ( )
virtual

Write.

Definition at line 130 of file surfaceInterpolateFields.C.

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

Referenced by surfaceInterpolateFields::name().

Here is the call graph for this function:

Here is the caller graph for this function:

virtual void updateMesh ( const mapPolyMesh )
inlinevirtual

Update for changes of mesh.

Definition at line 193 of file surfaceInterpolateFields.H.

virtual void movePoints ( const polyMesh )
inlinevirtual

Update for changes of mesh.

Definition at line 197 of file surfaceInterpolateFields.H.

Member Data Documentation

word name_
protected

Name of this set of surfaceInterpolateFields object.

Definition at line 112 of file surfaceInterpolateFields.H.

Referenced by surfaceInterpolateFields::name().

const objectRegistry& obr_
protected

Definition at line 114 of file surfaceInterpolateFields.H.

bool active_
protected

on/off switch

Definition at line 117 of file surfaceInterpolateFields.H.

List<Tuple2<word, word> > fieldSet_
protected

Fields to process.

wordList fieldSet_;

Definition at line 121 of file surfaceInterpolateFields.H.

PtrList<surfaceScalarField> ssf_
protected

Locally constructed fields.

Definition at line 124 of file surfaceInterpolateFields.H.

PtrList<surfaceVectorField> svf_
protected

Definition at line 125 of file surfaceInterpolateFields.H.

PtrList<surfaceSphericalTensorField> sSpheretf_
protected

Definition at line 126 of file surfaceInterpolateFields.H.

PtrList<surfaceSymmTensorField> sSymmtf_
protected

Definition at line 127 of file surfaceInterpolateFields.H.

PtrList<surfaceTensorField> stf_
protected

Definition at line 128 of file surfaceInterpolateFields.H.


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