cyclicTransform Class Reference

Cyclic plane transformation. More...

Inheritance diagram for cyclicTransform:
Collaboration diagram for cyclicTransform:

Public Types

enum  transformTypes { UNSPECIFIED , NONE , ROTATIONAL , TRANSLATIONAL }
 

Public Member Functions

 TypeName ("cyclicTransform")
 Runtime type information. More...
 
 cyclicTransform ()
 
 cyclicTransform (const bool defaultIsNone)
 
 cyclicTransform (const dictionary &dict, const bool defaultIsNone)
 
 cyclicTransform (const word &name, const vectorField &areas, const cyclicTransform &transform, const word &nbrName, const cyclicTransform &nbrTransform, const scalar matchTolerance, const bool global=false)
 Construct from coupled patch data. Copies from the supplied. More...
 
 cyclicTransform (const word &name, const pointField &ctrs, const vectorField &areas, const cyclicTransform &transform, const word &nbrName, const pointField &nbrCtrs, const vectorField &nbrAreas, const cyclicTransform &nbrTransform, const scalar matchTolerance, const bool global=false)
 Construct from coupled patch data. Copies from the supplied. More...
 
virtual ~cyclicTransform ()
 
transformTypes transformType () const
 Type of transform. More...
 
bool transformComplete () const
 Is the transform fully specified? More...
 
const transformer & transform () const
 Return transformation between the coupled patches. More...
 
void write (Ostream &os) const
 Write the data to a dictionary. More...
 

Static Public Attributes

static const NamedEnum< transformTypes, 4 > transformTypeNames
 

Friends

cyclicTransform operator& (const transformer &t, const cyclicTransform &c)
 
cyclicTransform inv (const cyclicTransform &c)
 

Detailed Description

Cyclic plane transformation.

Source files

Definition at line 50 of file cyclicTransform.H.

Member Enumeration Documentation

◆ transformTypes

Enumerator
UNSPECIFIED 
NONE 
ROTATIONAL 
TRANSLATIONAL 

Definition at line 54 of file cyclicTransform.H.

Constructor & Destructor Documentation

◆ cyclicTransform() [1/5]

Definition at line 221 of file cyclicTransform.C.

◆ cyclicTransform() [2/5]

cyclicTransform ( const bool  defaultIsNone)

Definition at line 227 of file cyclicTransform.C.

◆ cyclicTransform() [3/5]

cyclicTransform ( const dictionary &  dict,
const bool  defaultIsNone 
)

Definition at line 242 of file cyclicTransform.C.

◆ cyclicTransform() [4/5]

cyclicTransform ( const word &  name,
const vectorField &  areas,
const cyclicTransform &  transform,
const word &  nbrName,
const cyclicTransform &  nbrTransform,
const scalar  matchTolerance,
const bool  global = false 
)

Construct from coupled patch data. Copies from the supplied.

transform and neighbour transform. Suitable for geometrically dissimilar patches.

Definition at line 307 of file cyclicTransform.C.

References token::BEGIN_BLOCK, Foam::decrIndent(), token::END_BLOCK, Foam::exit(), Foam::FatalError, FatalErrorInFunction, Foam::incrIndent(), Foam::indent(), cyclicTransform::inv, Foam::mag(), Foam::name(), Foam::nl, Foam::sqrt(), Foam::sum(), cyclicTransform::UNSPECIFIED, and cyclicTransform::write().

Here is the call graph for this function:

◆ cyclicTransform() [5/5]

cyclicTransform ( const word &  name,
const pointField &  ctrs,
const vectorField &  areas,
const cyclicTransform &  transform,
const word &  nbrName,
const pointField &  nbrCtrs,
const vectorField &  nbrAreas,
const cyclicTransform &  nbrTransform,
const scalar  matchTolerance,
const bool  global = false 
)

◆ ~cyclicTransform()

~cyclicTransform ( )
virtual

Definition at line 541 of file cyclicTransform.C.

Member Function Documentation

◆ TypeName()

TypeName ( "cyclicTransform"  )

Runtime type information.

◆ transformType()

transformTypes transformType ( ) const
inline

Type of transform.

Definition at line 167 of file cyclicTransform.H.

Referenced by processorCyclicPolyPatch::transformType().

Here is the caller graph for this function:

◆ transformComplete()

bool transformComplete ( ) const
inline

Is the transform fully specified?

Definition at line 173 of file cyclicTransform.H.

◆ transform()

const transformer& transform ( ) const
inline

Return transformation between the coupled patches.

Definition at line 179 of file cyclicTransform.H.

References Foam::exit(), Foam::FatalError, and FatalErrorInFunction.

Referenced by mappedPatchBase::fromNeighbour(), cyclicPolyPatch::order(), and cyclicPolyPatch::transform().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ write()

void write ( Ostream &  os) const

Write the data to a dictionary.

Definition at line 547 of file cyclicTransform.C.

References Ostream::precision(), Foam::unitDegrees, and Foam::writeEntry().

Referenced by cyclicTransform::cyclicTransform(), and cyclicPolyPatch::write().

Here is the call graph for this function:
Here is the caller graph for this function:

Friends And Related Function Documentation

◆ operator&

cyclicTransform operator& ( const transformer &  t,
const cyclicTransform &  c 
)
friend

◆ inv

cyclicTransform inv ( const cyclicTransform &  c)
friend

Member Data Documentation

◆ transformTypeNames

const NamedEnum< cyclicTransform::transformTypes, 4 > transformTypeNames
static

Definition at line 62 of file cyclicTransform.H.


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