starcd Class Reference

A coordinateRotation defined by the STAR-CD convention. More...

Inheritance diagram for starcd:

Collaboration diagram for starcd:

Public Member Functions
	TypeNameNoDebug ("starcd")
	Runtime type information. More...
	starcd ()
	Default construct - an identity transform. More...
	starcd (const starcd &crot)
	Copy construct. More...
	starcd (const vector &rotZrotXrotY, bool degrees)
	Construct from rotation vector. More...
	starcd (scalar rotZ, scalar rotX, scalar rotY, bool degrees)
	Construct from components of rotation vector. More...
	starcd (const dictionary &dict)
	Construct from dictionary. More...
autoPtr< coordinateRotation >	clone () const
	Return clone. More...
virtual	~starcd ()=default
	Destructor. More...
virtual void	clear ()
	Reset specification. More...
virtual tensor	R () const
	The rotation tensor calculated for the specified STARCD angles. More...
virtual void	write (Ostream &os) const
	Write information. More...
virtual void	writeEntry (const word &keyword, Ostream &os) const
	Write dictionary entry. More...
Public Member Functions inherited from coordinateRotation
	TypeNameNoDebug ("coordinateRotation")
	Runtime type information. More...
	declareRunTimeSelectionTable (autoPtr, coordinateRotation, dictionary,(const dictionary &dict),(dict))
virtual	~coordinateRotation ()=default
	Destructor. More...

Static Public Member Functions
static tensor	rotation (const vector &angles, bool degrees)
	Rotation tensor calculated for the specified STARCD angles interpreted as rotate-Z, rotate-X, rotate-Y. More...
Static Public Member Functions inherited from coordinateRotation
static autoPtr< coordinateRotation >	New (const word &modelType, const dictionary &dict)
	Select construct the specified coordinate rotation type. More...
static autoPtr< coordinateRotation >	New (const dictionary &dict)
	Select construct from dictionary (requires the "type" entry) More...

Additional Inherited Members
Static Protected Member Functions inherited from coordinateRotation
static vector	findOrthogonal (const vector &axis)
	Determine best-guess for an orthogonal axis. More...

Detailed Description

A coordinateRotation defined by the STAR-CD convention.

The 3 rotations are defined in the STAR-CD convention (around Z, around X' and around Y''). The order of the parameter arguments matches this rotation order.

• the rotation angles are in degrees, unless otherwise explicitly specified:

rotation
{
    type    starcd;
    angles  (0 0 180);
}

Dictionary entries

Property	Description	Reqd	Default
type	Type name: starcd	yes
angles	The z-x-y rotation angles	yes
degrees	Angles are in degrees	no	true

Note

Also accepts "STARCDRotation" (OpenFOAM-v1806) for the type.

Source files

• STARCDCoordinateRotation.H
• STARCDCoordinateRotation.C

Definition at line 94 of file STARCDCoordinateRotation.H.

Constructor & Destructor Documentation

starcd() [1/5]

starcd

(

)

Default construct - an identity transform.

Definition at line 73 of file STARCDCoordinateRotation.C.

starcd() [2/5]

starcd

(

const starcd &

crot

)

Copy construct.

Definition at line 81 of file STARCDCoordinateRotation.C.

starcd() [3/5]

starcd	(	const vector &	rotZrotXrotY,
		bool	degrees
	)

Construct from rotation vector.

Definition at line 90 of file STARCDCoordinateRotation.C.

starcd() [4/5]

starcd	(	scalar	rotZ,
		scalar	rotX,
		scalar	rotY,
		bool	degrees
	)

Construct from components of rotation vector.

Definition at line 102 of file STARCDCoordinateRotation.C.

starcd() [5/5]

starcd ( const dictionary &  dict )

explicit

Construct from dictionary.

Definition at line 115 of file STARCDCoordinateRotation.C.

~starcd()

virtual ~starcd ( )

virtualdefault

Destructor.

Member Function Documentation

TypeNameNoDebug()

TypeNameNoDebug

(

"starcd"

)

Runtime type information.

clone()

autoPtr<coordinateRotation> clone ( ) const

inlinevirtual

Return clone.

Implements coordinateRotation.

Definition at line 149 of file STARCDCoordinateRotation.H.

rotation()

Foam::tensor rotation ( const vector &  angles, bool  degrees  )

static

Rotation tensor calculated for the specified STARCD angles interpreted as rotate-Z, rotate-X, rotate-Y.

Definition at line 62 of file STARCDCoordinateRotation.C.

Referenced by starcd::R().

Here is the caller graph for this function:

clear()

void clear ( )

virtual

Reset specification.

Implements coordinateRotation.

Definition at line 125 of file STARCDCoordinateRotation.C.

References Foam::Zero.

R()

Foam::tensor R ( ) const

virtual

The rotation tensor calculated for the specified STARCD angles.

Implements coordinateRotation.

Definition at line 132 of file STARCDCoordinateRotation.C.

References starcd::rotation().

Here is the call graph for this function:

write()

void write ( Ostream &  os ) const

virtual

Write information.

Implements coordinateRotation.

Definition at line 138 of file STARCDCoordinateRotation.C.

References os().

Here is the call graph for this function:

writeEntry()

void writeEntry ( const word &  keyword, Ostream &  os  ) const

virtual

Write dictionary entry.

Implements coordinateRotation.

Definition at line 145 of file STARCDCoordinateRotation.C.

References os(), and Foam::type().

Here is the call graph for this function:

---

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

• src/OpenFOAM/primitives/coordinate/rotation/STARCDCoordinateRotation.H
• src/OpenFOAM/primitives/coordinate/rotation/STARCDCoordinateRotation.C