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

This function object 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...

Collaboration diagram for fieldCoordinateSystemTransform:
Collaboration graph
[legend]

Public Member Functions

 TypeName ("fieldCoordinateSystemTransform")
 Runtime type information. More...
 
 fieldCoordinateSystemTransform (const word &name, const objectRegistry &, const dictionary &, const bool loadFromFiles=false)
 Construct for given objectRegistry and dictionary. More...
 
virtual ~fieldCoordinateSystemTransform ()
 Destructor. More...
 
virtual const wordname () const
 Return name of the fieldCoordinateSystemTransform object. More...
 
virtual void read (const dictionary &)
 Read the input 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

 fieldCoordinateSystemTransform (const fieldCoordinateSystemTransform &)
 Disallow default bitwise copy construct. More...
 
void operator= (const fieldCoordinateSystemTransform &)
 Disallow default bitwise assignment. More...
 
template<class Type >
void transform (const word &fieldName) const
 
template<class Type >
void transformField (const Type &field) const
 

Protected Attributes

word name_
 Name. More...
 
const objectRegistryobr_
 
bool active_
 on/off switch More...
 
wordList fieldSet_
 Fields to transform. More...
 
coordinateSystem coordSys_
 Co-ordinate system to transform to. More...
 

Detailed Description

This function object 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;
    functionObjectLibs ("libfieldFunctionObjects.so");
    ...
    fields
    (
        U
        UMean
        UPrime2Mean
    );
    coordinateSystem
    {
        origin  (0.001  0       0);
        e1      (1      0.15    0);
        e3      (0      0      -1);
    }
}


Function object 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::functionObject Foam::OutputFilterFunctionObject Foam::coordinateSystem
Source files

Definition at line 119 of file fieldCoordinateSystemTransform.H.

Constructor & Destructor Documentation

Disallow default bitwise copy construct.

fieldCoordinateSystemTransform ( 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 40 of file fieldCoordinateSystemTransform.C.

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

Here is the call graph for this function:

Destructor.

Definition at line 82 of file fieldCoordinateSystemTransform.C.

Member Function Documentation

void operator= ( const fieldCoordinateSystemTransform )
protected

Disallow default bitwise assignment.

void transform ( const word fieldName) const
protected

Definition at line 78 of file fieldCoordinateSystemTransformTemplates.C.

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

Referenced by fieldCoordinateSystemTransform::transformField().

Here is the call graph for this function:

Here is the caller graph for this function:

void transformField ( const Type &  field) const
protected

Definition at line 36 of file fieldCoordinateSystemTransformTemplates.C.

References Foam::endl(), Foam::Info, Foam::nl, R, Foam::transform(), fieldCoordinateSystemTransform::transform(), and Ostream::write().

Here is the call graph for this function:

TypeName ( "fieldCoordinateSystemTransform"  )

Runtime type information.

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

Read the input data.

Definition at line 88 of file fieldCoordinateSystemTransform.C.

References dictionary::lookup().

Referenced by fieldCoordinateSystemTransform::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 97 of file fieldCoordinateSystemTransform.C.

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

Referenced by fieldCoordinateSystemTransform::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 116 of file fieldCoordinateSystemTransform.C.

Referenced by fieldCoordinateSystemTransform::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 125 of file fieldCoordinateSystemTransform.C.

Referenced by fieldCoordinateSystemTransform::name().

Here is the caller graph for this function:

void write ( )
virtual

Write.

Definition at line 131 of file fieldCoordinateSystemTransform.C.

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

Referenced by fieldCoordinateSystemTransform::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 202 of file fieldCoordinateSystemTransform.H.

virtual void movePoints ( const polyMesh )
inlinevirtual

Update for changes of mesh.

Definition at line 206 of file fieldCoordinateSystemTransform.H.

Member Data Documentation

word name_
protected

Name.

Definition at line 126 of file fieldCoordinateSystemTransform.H.

Referenced by fieldCoordinateSystemTransform::name().

const objectRegistry& obr_
protected

Definition at line 128 of file fieldCoordinateSystemTransform.H.

bool active_
protected

on/off switch

Definition at line 131 of file fieldCoordinateSystemTransform.H.

wordList fieldSet_
protected

Fields to transform.

Definition at line 134 of file fieldCoordinateSystemTransform.H.

coordinateSystem coordSys_
protected

Co-ordinate system to transform to.

Definition at line 137 of file fieldCoordinateSystemTransform.H.


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