Public Member Functions | List of all members
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...

Inheritance diagram for specified:
[legend]
Collaboration diagram for specified:
[legend]

Public Member Functions

 TypeNameNoDebug ("specified")
 Runtime type information. More...
 
 specified ()
 Default construct - an identity matrix. More...
 
 specified (const tensor &rot)
 Construct from transformation matrix. More...
 
 specified (const dictionary &unused)
 Construct from dictionary. More...
 
autoPtr< coordinateRotation > clone () const
 Return clone. More...
 
virtual ~specified ()=default
 Destructor. More...
 
virtual void clear ()
 Reset specification. More...
 
virtual tensor R () const
 Return the rotation tensor. 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...
 

Additional Inherited Members

- Static Public Member Functions inherited from coordinateRotation
static autoPtr< coordinateRotation > New (const dictionary &dict)
 Select constructed from dictionary. More...
 
- Static Protected Member Functions inherited from coordinateRotation
static vector findOrthogonal (const vector &axis)
 Determine best-guess for an orthogonal axis. More...
 

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

Definition at line 61 of file specifiedRotation.H.

Constructor & Destructor Documentation

◆ specified() [1/3]

specified ( )

Default construct - an identity matrix.

Definition at line 48 of file specifiedRotation.C.

◆ specified() [2/3]

specified ( const tensor &  rot)
explicit

Construct from transformation matrix.

Definition at line 55 of file specifiedRotation.C.

◆ specified() [3/3]

specified ( const dictionary &  unused)
explicit

Construct from dictionary.

Definition at line 62 of file specifiedRotation.C.

◆ ~specified()

virtual ~specified ( )
virtualdefault

Destructor.

Member Function Documentation

◆ TypeNameNoDebug()

TypeNameNoDebug ( "specified"  )

Runtime type information.

◆ clone()

autoPtr<coordinateRotation> clone ( ) const
inlinevirtual

Return clone.

Implements coordinateRotation.

Definition at line 89 of file specifiedRotation.H.

◆ clear()

void clear ( )
virtual

Reset specification.

Implements coordinateRotation.

Definition at line 72 of file specifiedRotation.C.

References SphericalTensor< scalar >::I.

◆ R()

Foam::tensor R ( ) const
virtual

Return the rotation tensor.

Implements coordinateRotation.

Definition at line 78 of file specifiedRotation.C.

◆ write()

void write ( Ostream &  os) const
virtual

Write information.

Implements coordinateRotation.

Definition at line 84 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 91 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: