Transforms a user-specified selection of fields from global Cartesian coordinates to a local coordinate 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 ()=default
	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 ()=default
	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 ()=default
	Destructor. More...

template<class ObjectType >
const ObjectType *	lookupObjectPtr (const word &fieldName) const
	Deprecated(2018-10) More...

template<class ObjectType >
ObjectType *	lookupObjectRefPtr (const word &fieldName) const
	Deprecated(2018-10) More...

Public Member Functions inherited from stateFunctionObject
	stateFunctionObject (const word &name, const Time &runTime)
	Construct from components. More...

virtual	~stateFunctionObject ()=default
	Destructor. More...

dictionary &	propertyDict ()
	Return access to the property dictionary. More...

bool	foundProperty (const word &entryName) const
	Return true if the property exists. More...

label	getTrigger () const
	Get the current trigger index. More...

bool	setTrigger (const label triggeri)
	Set the current trigger index. More...

bool	getDict (const word &entryName, dictionary &dict) const
	Set dictionary, return true if set. More...

bool	getObjectDict (const word &objectName, const word &entryName, dictionary &dict) const
	Set dictionary from named object, return true if set. More...

template<class Type >
Type	getProperty (const word &entryName, const Type &defaultValue=Type(Zero)) const
	Retrieve generic property. More...

template<class Type >
bool	getProperty (const word &entryName, Type &value) const
	Set generic property, return true if set. More...

template<class Type >
void	setProperty (const word &entryName, const Type &value)
	Add generic property. More...

template<class Type >
Type	getObjectProperty (const word &objectName, const word &entryName, const Type &defaultValue=Type(Zero)) const
	Retrieve generic property from named object. More...

template<class Type >
bool	getObjectProperty (const word &objectName, const word &entryName, Type &value) const
	Set generic property from named object, return true if set. More...

template<class Type >
void	setObjectProperty (const word &objectName, const word &entryName, const Type &value)
	Add generic property from named object. More...

template<class Type >
void	setResult (const word &entryName, const Type &value)
	Add result. More...

template<class Type >
void	setObjectResult (const word &objectName, const word &entryName, const Type &value)
	Add result from named object. More...

template<class Type >
Type	getResult (const word &entryName, const Type &defaultValue=Type(Zero)) const
	Retrieve result. More...

template<class Type >
Type	getObjectResult (const word &objectName, const word &entryName, const Type &defaultValue=Type(Zero)) const
	Retrieve result from named object. More...

template<class Type >
bool	getObjectResult (const word &objectName, const word &entryName, Type &value) const
	Set result from named object, return true if set. More...

word	resultType (const word &entryName) const
	Retrieve the result type. More...

word	objectResultType (const word &objectName, const word &entryName) const
	Return the type of result. More...

List< word >	objectResultEntries () const
	Retrieve the result entries. More...

List< word >	objectResultEntries (const word &objectName) const
	Return result entries for named object. More...

void	writeResultEntries (Ostream &os) const
	Write the results entries for all objects to stream. More...

void	writeResultEntries (const word &objectName, Ostream &os) const
	Write the results entries for named object to stream. More...

void	writeAllResultEntries (Ostream &os) const
	Write the results entries for all objects to stream. More...

Public Member Functions inherited from timeFunctionObject
	timeFunctionObject (const word &name, const Time &runTime)
	Construct from Time. More...

virtual	~timeFunctionObject ()=default
	Destructor. More...

const Time &	time () const
	Return time database. More...

objectRegistry &	storedObjects ()

const objectRegistry &	storedObjects () const

Public Member Functions inherited from 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)
	Construct from components. More...

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

virtual	~functionObject ()=default
	Destructor. More...

const word &	name () const
	Return the name of this functionObject. More...

virtual bool	execute (const label subIndex)
	Execute using the specified subIndex. More...

virtual bool	end ()
	Called when Time::run() determines that the time-loop exits. More...

virtual bool	adjustTimeStep ()
	Called at the end of Time::adjustDeltaT() if adjustTime is true. More...

virtual bool	filesModified () const
	Did any file get changed during execution? 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...

const surfaceTensorField &	srotTensor () const
	Demand-driven non-uniform rotation field for surface fields. More...

const volTensorField &	vrotTensor () const
	Demand-driven non-uniform rotation field for volume fields. More...

template<class FieldType >
void	transformField (const FieldType &field)
	Transform the given field. More...

template<class FieldType , class RotationFieldType >
void	transformField (const RotationFieldType &rot, 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 fvMeshFunctionObject
	fvMeshFunctionObject (const fvMeshFunctionObject &)=delete
	No copy construct. More...

void	operator= (const fvMeshFunctionObject &)=delete
	No copy assignment. More...

Protected Member Functions inherited from regionFunctionObject
virtual const objectRegistry &	obr () const
	The region or sub-region registry being used. More...

template<class ObjectType >
bool	foundObject (const word &fieldName) const
	Find object (eg, a field) in the (sub) objectRegistry. More...

template<class ObjectType >
const ObjectType *	cfindObject (const word &fieldName) const

template<class ObjectType >
const ObjectType *	findObject (const word &fieldName) const

template<class ObjectType >
ObjectType *	findObject (const word &fieldName)

template<class ObjectType >
ObjectType *	getObjectPtr (const word &fieldName) const

template<class ObjectType >
const ObjectType &	lookupObject (const word &fieldName) const
	Lookup and return object (eg, a field) from the (sub) objectRegistry. More...

template<class ObjectType >
ObjectType &	lookupObjectRef (const word &fieldName) const
	Lookup and return object (eg, a field) from the (sub) objectRegistry. More...

template<class ObjectType >
bool	store (word &fieldName, const tmp< ObjectType > &tfield, bool cacheable=false)
	Store the field in the (sub) objectRegistry under the given name. More...

bool	writeObject (const word &fieldName)
	Write field if present in the (sub) objectRegistry. More...

bool	clearObject (const word &fieldName)
	Clear field from the (sub) objectRegistry if present. More...

void	clearObjects (const wordList &objNames)
	Clear fields from the (sub) objectRegistry if present. More...

	regionFunctionObject (const regionFunctionObject &)=delete
	No copy construct. More...

void	operator= (const regionFunctionObject &)=delete
	No copy assignment. More...

Protected Member Functions inherited from stateFunctionObject
const IOdictionary &	stateDict () const
	Return a const reference to the state dictionary. More...

IOdictionary &	stateDict ()
	Return non-const access to the state dictionary. More...

	stateFunctionObject (const stateFunctionObject &)=delete
	No copy construct. More...

void	operator= (const stateFunctionObject &)=delete
	No copy assignment. More...

Protected Member Functions inherited from timeFunctionObject
void	clearOutputObjects (const wordList &objNames)
	Remove specified items from "functionObjectObjects". More...

	timeFunctionObject (const timeFunctionObject &)=delete
	No copy construct. More...

void	operator= (const timeFunctionObject &)=delete
	No copy assignment. More...

Protected Member Functions inherited from functionObject
word	scopedName (const word &name) const
	Return a scoped name, e.g. used to construct local field names. More...

Protected Attributes
volFieldSelection	fieldSet_
	Fields to transform. More...

autoPtr< coordinateSystem >	csysPtr_
	Coordinate system to transform to. More...

autoPtr< surfaceTensorField >	rotTensorSurface_
	Demand-driven non-uniform rotation field (surface fields) More...

autoPtr< volTensorField >	rotTensorVolume_
	Demand-driven non-uniform rotation field (volume fields) More...

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

Protected Attributes inherited from regionFunctionObject
word	subRegistryName_
	Name for alternative object registry. More...

const objectRegistry &	obr_
	Reference to the region objectRegistry. More...

const objectRegistry *	obrPtr_
	Pointer to alternative (eg, sub-region) objectRegistry. More...

Protected Attributes inherited from timeFunctionObject
const Time &	time_
	Reference to the time database. More...

Additional Inherited Members
Static Public Member Functions inherited from functionObject
static autoPtr< functionObject >	New (const word &name, const Time &runTime, const dictionary &dict)
	Select from dictionary, based on its "type" entry. More...

Public Attributes inherited from functionObject
bool	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...

static word	outputPrefix
	Directory prefix. More...

Detailed Description

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

Usage

Example of function object specification:

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

    coordinateSystem
    {
        origin      (0.001 0 0);
        rotation
        {
            type    axes;
            e1      (1 0.15 0);
            e3      (0 0 -1);
        }
    }
}

Where the entries comprise:

Property	Description	Required
`type`	type name: fieldCoordinateSystemTransform	yes
`fields`	list of fields to be transformed	yes
`coordinateSystem`	local coordinate 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 54 of file fieldCoordinateSystemTransform.C.

References dict, Foam::endl(), Foam::Info, Foam::name(), Foam::nl, and Foam::blockMeshTools::read().

Here is the call graph for this function:

◆ ~fieldCoordinateSystemTransform()

virtual ~fieldCoordinateSystemTransform ( )

virtualdefault

Destructor.

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.

◆ srotTensor()

const Foam::surfaceTensorField & srotTensor ( ) const

protected

Demand-driven non-uniform rotation field for surface fields.

Definition at line 89 of file fieldCoordinateSystemTransform.C.

References fieldCoordinateSystemTransform::csysPtr_, Foam::dimless, primitiveMesh::faceCentres(), forAll, fvMeshFunctionObject::mesh_, IOobject::NO_READ, IOobject::NO_WRITE, Foam::foamVersion::patch, and fieldCoordinateSystemTransform::rotTensorSurface_.

Here is the call graph for this function:

◆ vrotTensor()

const Foam::volTensorField & vrotTensor ( ) const

protected

Demand-driven non-uniform rotation field for volume fields.

Definition at line 134 of file fieldCoordinateSystemTransform.C.

References Foam::dimless, forAll, IOobject::NO_READ, IOobject::NO_WRITE, and Foam::foamVersion::patch.

◆ transformField() [1/2]

void transformField ( const FieldType & field )

protected

Transform the given field.

Definition at line 38 of file fieldCoordinateSystemTransformTemplates.C.

References field(), and Foam::invTransform().

Here is the call graph for this function:

◆ transformField() [2/2]

void transformField	(	const RotationFieldType &	rot,
		const FieldType &	field
	)

protected

Transform the given field.

Definition at line 54 of file fieldCoordinateSystemTransformTemplates.C.

References field(), and Foam::invTransform().

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

References DebugInfo, and Foam::endl().

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 regionFunctionObject.

Definition at line 179 of file fieldCoordinateSystemTransform.C.

References dict, and regionFunctionObject::read().

Here is the call graph for this function:

◆ execute()

bool execute ( )

virtual

Calculate the transformed fields.

Implements functionObject.

Definition at line 193 of file fieldCoordinateSystemTransform.C.

◆ write()

bool write ( )

virtual

Write the transformed fields.

Implements functionObject.

Definition at line 214 of file fieldCoordinateSystemTransform.C.

Member Data Documentation

◆ fieldSet_

volFieldSelection fieldSet_

protected

Fields to transform.

Definition at line 125 of file fieldCoordinateSystemTransform.H.

◆ csysPtr_

autoPtr<coordinateSystem> csysPtr_

protected

Coordinate system to transform to.

Definition at line 128 of file fieldCoordinateSystemTransform.H.

Referenced by fieldCoordinateSystemTransform::srotTensor().

◆ rotTensorSurface_

autoPtr<surfaceTensorField> rotTensorSurface_

mutableprotected

Demand-driven non-uniform rotation field (surface fields)

Eg, for cylindrical coordinates

Definition at line 132 of file fieldCoordinateSystemTransform.H.

Referenced by fieldCoordinateSystemTransform::srotTensor().

◆ rotTensorVolume_

autoPtr<volTensorField> rotTensorVolume_

mutableprotected

Demand-driven non-uniform rotation field (volume fields)

Eg, for cylindrical coordinates

Definition at line 136 of file fieldCoordinateSystemTransform.H.

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()

◆ srotTensor()

◆ vrotTensor()

◆ transformField() [1/2]

◆ transformField() [2/2]

◆ transform()

◆ TypeName()

◆ read()

◆ execute()

◆ write()

Member Data Documentation

◆ fieldSet_

◆ csysPtr_

◆ rotTensorSurface_

◆ rotTensorVolume_