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

Transforms a user-specified selection of fields from global Cartesian co-ordinates to a local co-ordinate system. The fields are run-time modifiable. More...

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

Public Member Functions

 TypeName ("fieldCoordinateSystemTransform")
 Runtime type information. More...
 
 fieldCoordinateSystemTransform (const word &name, const Time &runTime, const dictionary &dict)
 Construct from Time and dictionary. More...
 
virtual ~fieldCoordinateSystemTransform ()
 Destructor. More...
 
virtual bool read (const dictionary &)
 Read the input data. More...
 
virtual bool execute ()
 Calculate the transformed fields. More...
 
virtual bool write ()
 Write the transformed fields. 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...
 
virtual ~fvMeshFunctionObject ()
 Destructor. 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...
 
virtual ~regionFunctionObject ()
 Destructor. More...
 
- Public Member Functions inherited from 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...
 
virtual ~functionObject ()
 Destructor. More...
 
const wordname () const
 Return the name of this functionObject. More...
 
virtual bool end ()
 Called when Time::run() determines that the time-loop exits. More...
 
virtual bool setTimeStep ()
 Called by Time::setDeltaT(). Allows the function object to override. More...
 
virtual scalar timeToNextWrite ()
 Called by Time::adjustTimeStep(). Allows the function object 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...
 

Protected Member Functions

word transformFieldName (const word &fieldName) const
 Return the name of the transformed field. More...
 
template<class FieldType >
void transformField (const FieldType &field)
 Transform the given field. More...
 
template<class Type >
void transform (const word &fieldName)
 Transform the given field if has the specified element type. More...
 
- Protected Member Functions inherited from regionFunctionObject
template<class ObjectType >
bool foundObject (const word &fieldName) const
 Find field in the objectRegistry. 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 (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

wordList fieldSet_
 Fields to transform. More...
 
coordinateSystem coordSys_
 Co-ordinate system to transform to. More...
 
- 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...
 
- Static Public Attributes inherited from functionObject
static int debug
 
static bool postProcess
 Global post-processing mode switch. More...
 

Detailed Description

Transforms a user-specified selection of fields from global Cartesian co-ordinates to a local co-ordinate system. The fields are run-time modifiable.

Example of function object specification:

fieldCoordinateSystemTransform1
{
    type        fieldCoordinateSystemTransform;
    libs        ("libfieldFunctionObjects.so");
    ...
    fields
    (
        U
        UMean
        UPrime2Mean
    );

    coordinateSystem
    {
        origin  (0.001 0 0);
        coordinateRotation
        {
            type        axesRotation;
            e1      (1      0.15    0);
            e3      (0      0      -1);
        }
    }
}
Usage
Property Description Required Default value
type type name: fieldCoordinateSystemTransform yes
fields list of fields to be transformed yes
coordinateSystem local co-ordinate system yes
See also
Foam::functionObjects::fvMeshFunctionObject Foam::coordinateSystem
Source files

Definition at line 113 of file fieldCoordinateSystemTransform.H.

Constructor & Destructor Documentation

◆ fieldCoordinateSystemTransform()

fieldCoordinateSystemTransform ( const word name,
const Time runTime,
const dictionary dict 
)

Construct from Time and dictionary.

Definition at line 51 of file fieldCoordinateSystemTransform.C.

References Foam::endl(), Log, Foam::nl, Foam::read(), Foam::type(), and fieldCoordinateSystemTransform::~fieldCoordinateSystemTransform().

Here is the call graph for this function:

◆ ~fieldCoordinateSystemTransform()

Destructor.

Definition at line 72 of file fieldCoordinateSystemTransform.C.

References fieldCoordinateSystemTransform::transformFieldName().

Referenced by fieldCoordinateSystemTransform::fieldCoordinateSystemTransform().

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

Member Function Documentation

◆ transformFieldName()

Foam::word transformFieldName ( const word fieldName) const
protected

Return the name of the transformed field.

Definition at line 80 of file fieldCoordinateSystemTransform.C.

References fieldCoordinateSystemTransform::read().

Referenced by fieldCoordinateSystemTransform::~fieldCoordinateSystemTransform().

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

◆ transformField()

void transformField ( const FieldType &  field)
protected

Transform the given field.

Definition at line 35 of file fieldCoordinateSystemTransformTemplates.C.

References Foam::transform(), and fieldCoordinateSystemTransform::transform().

Here is the call graph for this function:

◆ transform()

void transform ( const word fieldName)
protected

Transform the given field if has the specified element type.

Definition at line 51 of file fieldCoordinateSystemTransformTemplates.C.

References DebugInfo, Foam::endl(), and Foam::type().

Referenced by fieldCoordinateSystemTransform::transformField().

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

◆ TypeName()

TypeName ( "fieldCoordinateSystemTransform"  )

Runtime type information.

◆ read()

bool read ( const dictionary dict)
virtual

Read the input data.

Reimplemented from regionFunctionObject.

Definition at line 89 of file fieldCoordinateSystemTransform.C.

References dictionary::lookup(), and regionFunctionObject::read().

Referenced by fieldCoordinateSystemTransform::transformFieldName().

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

◆ execute()

bool execute ( )
virtual

Calculate the transformed fields.

Implements functionObject.

Definition at line 101 of file fieldCoordinateSystemTransform.C.

References forAll.

◆ write()

bool write ( )
virtual

Write the transformed fields.

Implements functionObject.

Definition at line 116 of file fieldCoordinateSystemTransform.C.

References forAll.

Member Data Documentation

◆ fieldSet_

wordList fieldSet_
protected

Fields to transform.

Definition at line 122 of file fieldCoordinateSystemTransform.H.

◆ coordSys_

coordinateSystem coordSys_
protected

Co-ordinate system to transform to.

Definition at line 125 of file fieldCoordinateSystemTransform.H.


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