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:

[legend]

Collaboration diagram for fieldCoordinateSystemTransform:

[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 wordList	fields () const
	Return the field required. 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)
	Construct from the region objectRegistry. More...

	fvMeshFunctionObject (const fvMeshFunctionObject &)=delete
	Disallow default bitwise copy construction. More...

virtual	~fvMeshFunctionObject ()
	Destructor. More...

const fvMesh &	mesh () const
	Return a reference to the mesh. 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)
	Construct from the region objectRegistry. 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 objectRegistryFunctionObject
	TypeName ("objectRegistryFunctionObject")
	Runtime type information. More...

	objectRegistryFunctionObject (const word &name, const objectRegistry &obr, const dictionary &dict)
	Construct from an objectRegistry and dictionary. More...

	objectRegistryFunctionObject (const word &name, const objectRegistry &obr)
	Construct from an objectRegistry. More...

	objectRegistryFunctionObject (const objectRegistryFunctionObject &)=delete
	Disallow default bitwise copy construction. More...

virtual	~objectRegistryFunctionObject ()
	Destructor. More...

void	operator= (const objectRegistryFunctionObject &)=delete
	Disallow default bitwise assignment. More...

Public Member Functions inherited from functionObject
	ClassName ("functionObject")

virtual const word &	type () 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, const Time &runTime)
	Construct from components. More...

	functionObject (const word &name, const Time &runTime, const dictionary &dict)
	Construct from dictionary. More...

autoPtr< functionObject >	clone () const
	Return clone. More...

	functionObject (const functionObject &)=delete
	Disallow default bitwise copy construction. More...

virtual	~functionObject ()
	Destructor. More...

const word &	name () 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	timeToNextAction ()
	Called by Time::adjustTimeStep(). Allows the functionObject to. More...

virtual scalar	maxDeltaT () const
	Return the maximum time-step for stable operation. 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...

virtual void	distribute (const polyDistributionMap &)
	Redistribute or update using the given distribution map. More...

void	operator= (const functionObject &)=delete
	Disallow default bitwise assignment. 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 objectRegistryFunctionObject
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...

void	cannotFindObjects (const wordList &fieldNames)
	Prints a warning message that fieldNames 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 >
ObjectType &	store (const tmp< ObjectType > &tfield)
	Store the given field in the objectRegistry. More...

template<class ObjectType >
ObjectType &	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
wordList	fields_
	Fields to transform. More...

coordinateSystem	coordSys_
	Co-ordinate system to transform to. More...

Protected Attributes inherited from fvMeshFunctionObject
const fvMesh &	mesh_
	Reference to the fvMesh. More...

Protected Attributes inherited from objectRegistryFunctionObject
const objectRegistry &	obr_
	Reference to the objectRegistry. More...

Protected Attributes inherited from functionObject
const Time &	time_
	Reference to time. More...

Additional Inherited Members
Static Public Member Functions inherited from functionObject
static autoPtr< functionObject >	New (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 execute at start time. More...

Static Public Attributes inherited from functionObject
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");

    writeControl    writeTime;

    fields
    (
        U
        UMean
        UPrime2Mean
    );

    coordinateSystem
    {
        type    cartesian;
        origin  (0.001 0 0);
        coordinateRotation
        {
            type        axesRotation;
            e1      (1      0.15    0);
            e3      (0      0      -1);
        }
    }
}

Usage

Property	Description	Required
`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 116 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 49 of file fieldCoordinateSystemTransform.C.

References fieldCoordinateSystemTransform::coordSys_, dict, Foam::endl(), Log, functionObject::name(), Foam::nl, fieldCoordinateSystemTransform::read(), and functionObject::type().

Here is the call graph for this function:

◆ ~fieldCoordinateSystemTransform()

~fieldCoordinateSystemTransform ( )

virtual

Destructor.

Definition at line 71 of file fieldCoordinateSystemTransform.C.

Member Function Documentation

◆ transformFieldName()

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

protected

Return the name of the transformed field.

Definition at line 79 of file fieldCoordinateSystemTransform.C.

Referenced by fieldCoordinateSystemTransform::transformField().

Here is the caller graph for this function:

◆ transformField()

void transformField ( const FieldType & field )

protected

Transform the given field.

Definition at line 34 of file fieldCoordinateSystemTransformTemplates.C.

References fieldCoordinateSystemTransform::coordSys_, coordinateSystem::R(), coordinateRotation::R(), objectRegistryFunctionObject::store(), Foam::transform(), and fieldCoordinateSystemTransform::transformFieldName().

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 50 of file fieldCoordinateSystemTransformTemplates.C.

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

Here is the call graph for this function:

◆ TypeName()

TypeName ( "fieldCoordinateSystemTransform" )

Runtime type information.

◆ read()

bool read ( const dictionary & dict )

virtual

Read the input data.

Reimplemented from objectRegistryFunctionObject.

Definition at line 88 of file fieldCoordinateSystemTransform.C.

References dict, and objectRegistryFunctionObject::read().

Referenced by fieldCoordinateSystemTransform::fieldCoordinateSystemTransform().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ fields()

Foam::wordList fields ( ) const

virtual

Return the field required.

Implements functionObject.

Definition at line 102 of file fieldCoordinateSystemTransform.C.

◆ execute()

bool execute ( )

virtual

Calculate the transformed fields.

Implements functionObject.

Definition at line 108 of file fieldCoordinateSystemTransform.C.

References forAll.

◆ write()

bool write ( )

virtual

Write the transformed fields.

Implements functionObject.

Definition at line 123 of file fieldCoordinateSystemTransform.C.

References forAll.

Member Data Documentation

◆ fields_

wordList fields_

protected

Fields to transform.

Definition at line 125 of file fieldCoordinateSystemTransform.H.

◆ coordSys_

coordinateSystem coordSys_

protected

Co-ordinate system to transform to.

Definition at line 128 of file fieldCoordinateSystemTransform.H.

Referenced by fieldCoordinateSystemTransform::fieldCoordinateSystemTransform(), and fieldCoordinateSystemTransform::transformField().

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

src/functionObjects/field/fieldCoordinateSystemTransform/fieldCoordinateSystemTransform.H
src/functionObjects/field/fieldCoordinateSystemTransform/fieldCoordinateSystemTransform.C
src/functionObjects/field/fieldCoordinateSystemTransform/fieldCoordinateSystemTransformTemplates.C

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ fieldCoordinateSystemTransform()

◆ ~fieldCoordinateSystemTransform()

Member Function Documentation

◆ transformFieldName()

◆ transformField()

◆ transform()

◆ TypeName()

◆ read()

◆ fields()

◆ execute()

◆ write()

Member Data Documentation

◆ fields_

◆ coordSys_