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:

[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 word &	name () 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 objectRegistry &	obr_

bool	active_
	on/off switch More...

wordList	fieldSet_
	Fields to transform. More...

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

Switch	log_
	Switch to send output to Info as well as to file. 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
    );
    origin      (0.001 0 0);

    coordinateRotation
    {
        type    axesRotation;
        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
`origin`	origin of local co-ordinate system	yes
`coordinateRotation`	orientation of local co-ordinate system	yes
`log`	Log to standard output	no	yes

See also: Foam::functionObject Foam::OutputFilterFunctionObject Foam::coordinateSystem

Source files

Definition at line 133 of file fieldCoordinateSystemTransform.H.

Constructor & Destructor Documentation

◆ fieldCoordinateSystemTransform() [1/2]

fieldCoordinateSystemTransform ( const fieldCoordinateSystemTransform & )

protected

Disallow default bitwise copy construct.

◆ fieldCoordinateSystemTransform() [2/2]

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 dict, Foam::endl(), Foam::Info, Foam::nl, Foam::read(), Foam::type(), and WarningInFunction.

Here is the call graph for this function:

◆ ~fieldCoordinateSystemTransform()

~fieldCoordinateSystemTransform ( )

virtual

Destructor.

Definition at line 76 of file fieldCoordinateSystemTransform.C.

Member Function Documentation

◆ operator=()

void operator= ( const fieldCoordinateSystemTransform & )

protected

Disallow default bitwise assignment.

◆ transform()

void transform ( const word & fieldName ) const

protected

Definition at line 78 of file fieldCoordinateSystemTransformTemplates.C.

References Foam::endl(), IOobject::headerClassName(), IOobject::headerOk(), Foam::Info, and Foam::type().

Here is the call graph for this function:

◆ transformField()

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(), and Ostream::write().

Here is the call graph for this function:

◆ TypeName()

TypeName ( "fieldCoordinateSystemTransform" )

Runtime type information.

◆ name()

virtual const word& name ( ) const

inlinevirtual

Return name of the fieldCoordinateSystemTransform object.

Definition at line 198 of file fieldCoordinateSystemTransform.H.

References fieldCoordinateSystemTransform::name_.

◆ read()

void read ( const dictionary & dict )

virtual

Read the input data.

Definition at line 82 of file fieldCoordinateSystemTransform.C.

References dict, and dictionary::lookup().

Here is the call graph for this function:

◆ execute()

void execute ( )

virtual

Execute, currently does nothing.

Definition at line 92 of file fieldCoordinateSystemTransform.C.

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

Here is the call graph for this function:

◆ end()

void end ( )

virtual

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

Definition at line 111 of file fieldCoordinateSystemTransform.C.

◆ timeSet()

void timeSet ( )

virtual

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

Definition at line 117 of file fieldCoordinateSystemTransform.C.

◆ write()

void write ( )

virtual

Write.

Definition at line 123 of file fieldCoordinateSystemTransform.C.

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

Here is the call graph for this function:

◆ updateMesh()

virtual void updateMesh ( const mapPolyMesh & )

inlinevirtual

Update for changes of mesh.

Definition at line 219 of file fieldCoordinateSystemTransform.H.

◆ movePoints()

virtual void movePoints ( const polyMesh & )

inlinevirtual

Update for changes of mesh.

Definition at line 223 of file fieldCoordinateSystemTransform.H.

Field Documentation

◆ name_

word name_

protected

Name.

Definition at line 140 of file fieldCoordinateSystemTransform.H.

Referenced by fieldCoordinateSystemTransform::name().

◆ obr_

const objectRegistry& obr_

protected

Definition at line 142 of file fieldCoordinateSystemTransform.H.

◆ active_

bool active_

protected

on/off switch

Definition at line 145 of file fieldCoordinateSystemTransform.H.

◆ fieldSet_

wordList fieldSet_

protected

Fields to transform.

Definition at line 148 of file fieldCoordinateSystemTransform.H.

◆ coordSys_

coordinateSystem coordSys_

protected

Co-ordinate system to transform to.

Definition at line 151 of file fieldCoordinateSystemTransform.H.

◆ log_

Switch log_

protected

Switch to send output to Info as well as to file.

Definition at line 154 of file fieldCoordinateSystemTransform.H.

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

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

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ fieldCoordinateSystemTransform() [1/2]

◆ fieldCoordinateSystemTransform() [2/2]

◆ ~fieldCoordinateSystemTransform()

Member Function Documentation

◆ operator=()

◆ transform()

◆ transformField()

◆ TypeName()

◆ name()

◆ read()

◆ execute()

◆ end()

◆ timeSet()

◆ write()

◆ updateMesh()

◆ movePoints()

Field Documentation

◆ name_

◆ obr_

◆ active_

◆ fieldSet_

◆ coordSys_

◆ log_