specified Class Reference

An user-specified coordinateRotation, primarily to be used internally within coding when the rotation matrix is already known but needs to be wrapped as a coordinateRotation for use in a coordinate system. More...

#include <specifiedRotation.H>

Inheritance diagram for specified:

Collaboration diagram for specified:

Public Member Functions
	TypeNameNoDebug ("specified")
	Runtime type information.
	specified ()
	Default construct - an identity matrix.
	specified (const tensor &rot)
	Construct from transformation matrix.
	specified (const dictionary &unused)
	Construct from dictionary.
autoPtr< coordinateRotation >	clone () const
	Return clone.
virtual	~specified ()=default
	Destructor.
virtual void	clear ()
	Reset specification.
virtual tensor	R () const
	Return the rotation tensor.
virtual void	write (Ostream &os) const
	Write information.
virtual void	writeEntry (const word &keyword, Ostream &os) const
	Write dictionary entry.
Public Member Functions inherited from coordinateRotation
	TypeNameNoDebug ("coordinateRotation")
	Runtime type information.
	declareRunTimeSelectionTable (autoPtr, coordinateRotation, dictionary,(const dictionary &dict),(dict))
virtual	~coordinateRotation ()=default
	Destructor.

Additional Inherited Members
Static Public Member Functions inherited from coordinateRotation
template<class Derived>
static autoPtr< coordinateRotation >	Clone (const Derived &crot)
	Clone a coordinate rotation.
static autoPtr< coordinateRotation >	New (const word &modelType, const dictionary &dict)
	Select construct the specified coordinate rotation type.
static autoPtr< coordinateRotation >	New (const dictionary &dict)
	Select construct from dictionary (requires the "type" entry).
Static Protected Member Functions inherited from coordinateRotation
static vector	findOrthogonal (const vector &axis)
	Determine best-guess for an orthogonal axis.

Detailed Description

An user-specified coordinateRotation, primarily to be used internally within coding when the rotation matrix is already known but needs to be wrapped as a coordinateRotation for use in a coordinate system.

Note

Currently no runtime selection mechanism, since specifying a rotation matrix via a dictionary can be fragile due to rounding factors and uncertainty if a forward or reverse rotation matrix is intended.

Source files

• specifiedRotation.H
• specifiedRotation.C

Definition at line 57 of file specifiedRotation.H.

Constructor & Destructor Documentation

specified() [1/3]

specified

(

)

Default construct - an identity matrix.

Definition at line 41 of file specifiedRotation.C.

References Foam::I.

Referenced by specified().

Here is the caller graph for this function:

specified() [2/3]

specified ( const tensor & rot )

explicit

Construct from transformation matrix.

Definition at line 48 of file specifiedRotation.C.

specified() [3/3]

specified ( const dictionary & unused )

explicit

Construct from dictionary.

Definition at line 55 of file specifiedRotation.C.

References dict, and specified().

Here is the call graph for this function:

~specified()

virtual ~specified ( )

virtualdefault

Destructor.

References os().

Here is the call graph for this function:

Member Function Documentation

TypeNameNoDebug()

TypeNameNoDebug

(

"specified"

)

Runtime type information.

clone()

autoPtr< coordinateRotation > clone ( ) const

inlinevirtual

Return clone.

Implements coordinateRotation.

Definition at line 97 of file specifiedRotation.H.

References coordinateRotation::Clone().

Here is the call graph for this function:

clear()

void clear ( )

virtual

Reset specification.

Implements coordinateRotation.

Definition at line 65 of file specifiedRotation.C.

References SphericalTensor< scalar >::I.

R()

Foam::tensor R ( ) const

virtual

Return the rotation tensor.

Implements coordinateRotation.

Definition at line 71 of file specifiedRotation.C.

write()

void write ( Ostream & os ) const

virtual

Write information.

Implements coordinateRotation.

Definition at line 77 of file specifiedRotation.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 83 of file specifiedRotation.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/specifiedRotation.H
• src/OpenFOAM/primitives/coordinate/rotation/specifiedRotation.C