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...

string	str () const
	Generate a string representation of the transform. More...

Static Public Attributes
static const NamedEnum< transformTypes, 4 >	transformTypeNames

static const wordList	keywords

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

enum transformTypes

Enumerator
UNSPECIFIED
NONE
ROTATIONAL
TRANSLATIONAL

Definition at line 54 of file cyclicTransform.H.

Constructor & Destructor Documentation

◆ cyclicTransform() [1/5]

cyclicTransform ( )

Definition at line 229 of file cyclicTransform.C.

◆ cyclicTransform() [2/5]

cyclicTransform ( const bool defaultIsNone )

Definition at line 235 of file cyclicTransform.C.

◆ cyclicTransform() [3/5]

cyclicTransform	(	const dictionary &	dict,
		const bool	defaultIsNone
	)

Definition at line 250 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 315 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`
	)

Construct from coupled patch data. Copies from the supplied.

transform and neighbour transform, then tries to determine missing parts of the transformation automatically from the patch geometry. Suitable for geometrically similar patches only.

Definition at line 369 of file cyclicTransform.C.

References Foam::saturationModels::A, Foam::acos(), b, token::BEGIN_BLOCK, Foam::stringOps::breakIntoIndentedLines(), Foam::cmptMag(), Foam::decrIndent(), delta, Foam::dot(), token::END_BLOCK, Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, Foam::findMax(), forAll, Tensor< scalar >::I, Foam::incrIndent(), Foam::Info, cyclicTransform::inv, Foam::mag(), Foam::max(), Foam::min(), Foam::name(), Foam::nl, cyclicTransform::NONE, Foam::normalised(), quaternion::R(), Foam::R(), cyclicTransform::ROTATIONAL, Foam::sign(), List< T >::size(), Foam::sqr(), Foam::sqrt(), cyclicTransform::str(), Foam::sum(), transformer::transformPosition(), cyclicTransform::TRANSLATIONAL, cyclicTransform::UNSPECIFIED, and cyclicTransform::write().

Here is the call graph for this function:

◆ ~cyclicTransform()

~cyclicTransform ( )

virtual

Definition at line 549 of file cyclicTransform.C.

Member Function Documentation

◆ TypeName()

TypeName ( "cyclicTransform" )

Runtime type information.

◆ transformType()

transformTypes transformType ( ) const

inline

Type of transform.

Definition at line 169 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 175 of file cyclicTransform.H.

◆ transform()

const transformer& transform ( ) const

inline

Return transformation between the coupled patches.

Definition at line 181 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 555 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:

◆ str()

Foam::string str ( ) const

Generate a string representation of the transform.

Definition at line 589 of file cyclicTransform.C.

References OStringStream::str(), unitConversion::toUser(), and Foam::unitDegrees.

Referenced by cyclicTransform::cyclicTransform(), nonConformalCyclicPolyPatch::intersection(), and nonConformalCyclicPolyPatch::rays().

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

Referenced by cyclicTransform::cyclicTransform().

Member Data Documentation

◆ transformTypeNames

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

static

Initial value:

{
    "unspecified",
    "none",
    "rotational",
    "translational"
}

Definition at line 62 of file cyclicTransform.H.

◆ keywords

const Foam::wordList keywords

static

Initial value:

{
    "transformType",
    "transform",
    "rotationAxis",
    "rotationCentre",
    "rotationAngle",
    "separation",
    "separationVector"
}

Definition at line 64 of file cyclicTransform.H.

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

src/OpenFOAM/meshes/polyMesh/polyPatches/constraint/cyclic/cyclicTransform.H
src/OpenFOAM/meshes/polyMesh/polyPatches/constraint/cyclic/cyclicTransform.C

Public Types

Public Member Functions

Static Public Attributes

Friends

Detailed Description

Member Enumeration Documentation

◆ transformTypes

Constructor & Destructor Documentation

◆ cyclicTransform() [1/5]

◆ cyclicTransform() [2/5]

◆ cyclicTransform() [3/5]

◆ cyclicTransform() [4/5]

◆ cyclicTransform() [5/5]

◆ ~cyclicTransform()

Member Function Documentation

◆ TypeName()

◆ transformType()

◆ transformComplete()

◆ transform()

◆ write()

◆ str()

Friends And Related Function Documentation

◆ operator&

◆ inv

Member Data Documentation

◆ transformTypeNames

◆ keywords