A cylindrical coordinate system (r-theta-z). The coordinate system angle theta is always in radians. More...

Inheritance diagram for cylindrical:

Collaboration diagram for cylindrical:

Public Member Functions
	TypeNameNoDebug ("cylindrical")

	cylindrical ()

	cylindrical (const cylindrical &csys)=default

	cylindrical (cylindrical &&csys)=default

	cylindrical (const coordinateSystem &csys)

	cylindrical (coordinateSystem &&csys)

	cylindrical (autoPtr< coordinateSystem > &&csys)

	cylindrical (const coordinateRotation &crot)

	cylindrical (const point &origin, const coordinateRotation &crot)

	cylindrical (const point &origin, const vector &axis)

	cylindrical (const word &name, const point &origin, const vector &axis)

	cylindrical (const point &origin, const vector &axis, const vector &dirn)

	cylindrical (const word &name, const point &origin, const vector &axis, const vector &dirn)

	cylindrical (const word &name, const dictionary &dict)

	cylindrical (const dictionary &dict)

	cylindrical (const dictionary &dict, const word &dictName)

virtual autoPtr< coordinateSystem >	clone () const

virtual	~cylindrical ()=default

virtual bool	uniform () const

virtual tensor	R (const point &global) const

cylindrical &	operator= (const cylindrical &)=default

cylindrical &	operator= (cylindrical &&)=default

virtual const tensor &	R () const

virtual tensor	R (const point &global) const

virtual tmp< tensorField >	R (const UList< point > &global) const

virtual tmp< tensorField >	R (const pointUIndList &global) const

Public Member Functions inherited from coordinateSystem
	TypeName ("coordinateSystem")

	coordinateSystem ()

	coordinateSystem (const coordinateRotation &crot)

	coordinateSystem (coordinateRotation &&crot)

	coordinateSystem (const coordinateSystem &csys)

	coordinateSystem (coordinateSystem &&csys)

	coordinateSystem (autoPtr< coordinateSystem > &&csys)

	coordinateSystem (const word &name, const coordinateSystem &csys)

	coordinateSystem (const point &origin, const coordinateRotation &crot)

	coordinateSystem (const point &origin, const vector &axis, const vector &dirn)

	coordinateSystem (const word &name, const point &origin, const coordinateRotation &crot)

	coordinateSystem (const word &name, const point &origin, const vector &axis, const vector &dirn)

	coordinateSystem (const word &name, const dictionary &dict)

	coordinateSystem (const dictionary &dict)

	coordinateSystem (const dictionary &dict, const word &dictName)

	declareRunTimeSelectionTable (autoPtr, coordinateSystem, dictionary,(const dictionary &dict),(dict))

	declareRunTimeSelectionTable (autoPtr, coordinateSystem, registry,(const objectRegistry &obr, const dictionary &dict),(obr, dict))

virtual	~coordinateSystem ()=default

virtual bool	valid () const

virtual const coordinateRotation &	rotation () const

virtual const word &	name () const

virtual const string &	note () const

virtual const point &	origin () const

virtual const tensor &	R () const

virtual const vector	e1 () const

virtual const vector	e2 () const

virtual const vector	e3 () const

virtual void	rename (const word &newName)

virtual string &	note ()

virtual point &	origin ()

virtual void	clear ()

virtual void	rotation (autoPtr< coordinateRotation > &&crot)

virtual void	write (Ostream &os) const

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

void	operator= (const coordinateSystem &csys)

void	operator= (coordinateSystem &&csys)

void	operator= (const autoPtr< coordinateSystem > &csys)

void	operator= (autoPtr< coordinateSystem > &&csys)

virtual tmp< tensorField >	R (const UList< point > &global) const

virtual tmp< tensorField >	R (const pointUIndList &global) const

point	transformPoint (const point &localCart) const

tmp< pointField >	transformPoint (const UList< point > &localCart) const

tmp< pointField >	transformPoint (const pointUIndList &localCart) const

point	invTransformPoint (const point &global) const

tmp< pointField >	invTransformPoint (const UList< point > &global) const

tmp< pointField >	invTransformPoint (const pointUIndList &global) const

point	globalPosition (const point &local) const

tmp< pointField >	globalPosition (const pointField &local) const

point	localPosition (const point &global) const

tmp< pointField >	localPosition (const pointField &global) const

vector	globalVector (const vector &local) const

tmp< vectorField >	globalVector (const vectorField &local) const

vector	localVector (const vector &global) const

tmp< vectorField >	localVector (const vectorField &global) const

virtual symmTensor	transformPrincipal (const vector &input) const
	With constant rotation tensor. More...

virtual tmp< Field< symmTensor > >	transformPrincipal (const UList< vector > &input) const
	With constant rotation tensor. More...

virtual symmTensor	transformPrincipal (const point &global, const vector &input) const
	With rotation tensor at given global position. More...

virtual tmp< Field< symmTensor > >	transformPrincipal (const UList< point > &global, const vector &input) const
	With rotation tensors at given global positions. More...

virtual tmp< Field< symmTensor > >	transformPrincipal (const pointUIndList &global, const vector &input) const
	With rotation tensors at given global positions. More...

virtual tmp< Field< symmTensor > >	transformPrincipal (const UList< point > &global, const UList< vector > &input) const
	With rotation tensors at given global positions. More...

virtual tmp< Field< symmTensor > >	transformPrincipal (const pointUIndList &global, const UList< vector > &input) const
	With rotation tensors at given global positions. More...

virtual scalar	transform (const scalar &input) const
	With constant rotation tensor. More...

virtual tmp< Field< scalar > >	transform (const UList< scalar > &input) const
	With constant rotation tensor. More...

virtual scalar	transform (const point &global, const scalar &input) const
	With rotation tensor at given global position. More...

virtual tmp< Field< scalar > >	transform (const UList< point > &global, const scalar &input) const
	With rotation tensors at given global positions. More...

virtual tmp< Field< scalar > >	transform (const pointUIndList &global, const scalar &input) const
	With rotation tensors at given global positions. More...

virtual tmp< Field< scalar > >	transform (const UList< point > &global, const UList< scalar > &input) const
	With rotation tensors at given global positions. More...

virtual tmp< Field< scalar > >	transform (const pointUIndList &global, const UList< scalar > &input) const
	With rotation tensors at given global positions. More...

virtual vector	transform (const vector &input) const
	With constant rotation tensor. More...

virtual tmp< Field< vector > >	transform (const UList< vector > &input) const
	With constant rotation tensor. More...

virtual vector	transform (const point &global, const vector &input) const
	With rotation tensor at given global position. More...

virtual tmp< Field< vector > >	transform (const UList< point > &global, const vector &input) const
	With rotation tensors at given global positions. More...

virtual tmp< Field< vector > >	transform (const pointUIndList &global, const vector &input) const
	With rotation tensors at given global positions. More...

virtual tmp< Field< vector > >	transform (const UList< point > &global, const UList< vector > &input) const
	With rotation tensors at given global positions. More...

virtual tmp< Field< vector > >	transform (const pointUIndList &global, const UList< vector > &input) const
	With rotation tensors at given global positions. More...

virtual sphericalTensor	transform (const sphericalTensor &input) const
	With constant rotation tensor. More...

virtual tmp< Field< sphericalTensor > >	transform (const UList< sphericalTensor > &input) const
	With constant rotation tensor. More...

virtual sphericalTensor	transform (const point &global, const sphericalTensor &input) const
	With rotation tensor at given global position. More...

virtual tmp< Field< sphericalTensor > >	transform (const UList< point > &global, const sphericalTensor &input) const
	With rotation tensors at given global positions. More...

virtual tmp< Field< sphericalTensor > >	transform (const pointUIndList &global, const sphericalTensor &input) const
	With rotation tensors at given global positions. More...

virtual tmp< Field< sphericalTensor > >	transform (const UList< point > &global, const UList< sphericalTensor > &input) const
	With rotation tensors at given global positions. More...

virtual tmp< Field< sphericalTensor > >	transform (const pointUIndList &global, const UList< sphericalTensor > &input) const
	With rotation tensors at given global positions. More...

virtual symmTensor	transform (const symmTensor &input) const
	With constant rotation tensor. More...

virtual tmp< Field< symmTensor > >	transform (const UList< symmTensor > &input) const
	With constant rotation tensor. More...

virtual symmTensor	transform (const point &global, const symmTensor &input) const
	With rotation tensor at given global position. More...

virtual tmp< Field< symmTensor > >	transform (const UList< point > &global, const symmTensor &input) const
	With rotation tensors at given global positions. More...

virtual tmp< Field< symmTensor > >	transform (const pointUIndList &global, const symmTensor &input) const
	With rotation tensors at given global positions. More...

virtual tmp< Field< symmTensor > >	transform (const UList< point > &global, const UList< symmTensor > &input) const
	With rotation tensors at given global positions. More...

virtual tmp< Field< symmTensor > >	transform (const pointUIndList &global, const UList< symmTensor > &input) const
	With rotation tensors at given global positions. More...

virtual tensor	transform (const tensor &input) const
	With constant rotation tensor. More...

virtual tmp< Field< tensor > >	transform (const UList< tensor > &input) const
	With constant rotation tensor. More...

virtual tensor	transform (const point &global, const tensor &input) const
	With rotation tensor at given global position. More...

virtual tmp< Field< tensor > >	transform (const UList< point > &global, const tensor &input) const
	With rotation tensors at given global positions. More...

virtual tmp< Field< tensor > >	transform (const pointUIndList &global, const tensor &input) const
	With rotation tensors at given global positions. More...

virtual tmp< Field< tensor > >	transform (const UList< point > &global, const UList< tensor > &input) const
	With rotation tensors at given global positions. More...

virtual tmp< Field< tensor > >	transform (const pointUIndList &global, const UList< tensor > &input) const
	With rotation tensors at given global positions. More...

virtual scalar	invTransform (const scalar &input) const
	With constant rotation tensor. More...

virtual tmp< Field< scalar > >	invTransform (const UList< scalar > &input) const
	With constant rotation tensor. More...

virtual scalar	invTransform (const point &global, const scalar &input) const
	With rotation tensor at given global position. More...

virtual tmp< Field< scalar > >	invTransform (const UList< point > &global, const scalar &input) const
	With rotation tensors at given global positions. More...

virtual tmp< Field< scalar > >	invTransform (const pointUIndList &global, const scalar &input) const
	With rotation tensors at given global positions. More...

virtual tmp< Field< scalar > >	invTransform (const UList< point > &global, const UList< scalar > &input) const
	With rotation tensors at given global positions. More...

virtual tmp< Field< scalar > >	invTransform (const pointUIndList &global, const UList< scalar > &input) const
	With rotation tensors at given global positions. More...

virtual vector	invTransform (const vector &input) const
	With constant rotation tensor. More...

virtual tmp< Field< vector > >	invTransform (const UList< vector > &input) const
	With constant rotation tensor. More...

virtual vector	invTransform (const point &global, const vector &input) const
	With rotation tensor at given global position. More...

virtual tmp< Field< vector > >	invTransform (const UList< point > &global, const vector &input) const
	With rotation tensors at given global positions. More...

virtual tmp< Field< vector > >	invTransform (const pointUIndList &global, const vector &input) const
	With rotation tensors at given global positions. More...

virtual tmp< Field< vector > >	invTransform (const UList< point > &global, const UList< vector > &input) const
	With rotation tensors at given global positions. More...

virtual tmp< Field< vector > >	invTransform (const pointUIndList &global, const UList< vector > &input) const
	With rotation tensors at given global positions. More...

virtual sphericalTensor	invTransform (const sphericalTensor &input) const
	With constant rotation tensor. More...

virtual tmp< Field< sphericalTensor > >	invTransform (const UList< sphericalTensor > &input) const
	With constant rotation tensor. More...

virtual sphericalTensor	invTransform (const point &global, const sphericalTensor &input) const
	With rotation tensor at given global position. More...

virtual tmp< Field< sphericalTensor > >	invTransform (const UList< point > &global, const sphericalTensor &input) const
	With rotation tensors at given global positions. More...

virtual tmp< Field< sphericalTensor > >	invTransform (const pointUIndList &global, const sphericalTensor &input) const
	With rotation tensors at given global positions. More...

virtual tmp< Field< sphericalTensor > >	invTransform (const UList< point > &global, const UList< sphericalTensor > &input) const
	With rotation tensors at given global positions. More...

virtual tmp< Field< sphericalTensor > >	invTransform (const pointUIndList &global, const UList< sphericalTensor > &input) const
	With rotation tensors at given global positions. More...

virtual symmTensor	invTransform (const symmTensor &input) const
	With constant rotation tensor. More...

virtual tmp< Field< symmTensor > >	invTransform (const UList< symmTensor > &input) const
	With constant rotation tensor. More...

virtual symmTensor	invTransform (const point &global, const symmTensor &input) const
	With rotation tensor at given global position. More...

virtual tmp< Field< symmTensor > >	invTransform (const UList< point > &global, const symmTensor &input) const
	With rotation tensors at given global positions. More...

virtual tmp< Field< symmTensor > >	invTransform (const pointUIndList &global, const symmTensor &input) const
	With rotation tensors at given global positions. More...

virtual tmp< Field< symmTensor > >	invTransform (const UList< point > &global, const UList< symmTensor > &input) const
	With rotation tensors at given global positions. More...

virtual tmp< Field< symmTensor > >	invTransform (const pointUIndList &global, const UList< symmTensor > &input) const
	With rotation tensors at given global positions. More...

virtual tensor	invTransform (const tensor &input) const
	With constant rotation tensor. More...

virtual tmp< Field< tensor > >	invTransform (const UList< tensor > &input) const
	With constant rotation tensor. More...

virtual tensor	invTransform (const point &global, const tensor &input) const
	With rotation tensor at given global position. More...

virtual tmp< Field< tensor > >	invTransform (const UList< point > &global, const tensor &input) const
	With rotation tensors at given global positions. More...

virtual tmp< Field< tensor > >	invTransform (const pointUIndList &global, const tensor &input) const
	With rotation tensors at given global positions. More...

virtual tmp< Field< tensor > >	invTransform (const UList< point > &global, const UList< tensor > &input) const
	With rotation tensors at given global positions. More...

virtual tmp< Field< tensor > >	invTransform (const pointUIndList &global, const UList< tensor > &input) const
	With rotation tensors at given global positions. More...

template<class PointField >
Foam::tmp< Foam::tensorField >	rotationsImpl (const PointField &global) const

template<class PointField >
Foam::tmp< Foam::pointField >	transformPointImpl (const PointField &localCart) const

template<class PointField >
Foam::tmp< Foam::pointField >	invTransformPointImpl (const PointField &global) const

template<class RetType , class Type , class BinaryOp >
Foam::tmp< Foam::Field< RetType > >	manyTimesImpl (const tensor &tt, const UList< Type > &input, const BinaryOp &bop)

template<class RetType , class PointField , class Type , class BinaryOp >
Foam::tmp< Foam::Field< RetType > >	oneToOneImpl (const PointField &global, const UList< Type > &input, const BinaryOp &bop) const

template<class RetType , class PointField , class Type , class BinaryOp >
Foam::tmp< Foam::Field< RetType > >	oneToManyImpl (const PointField &global, const Type &input, const BinaryOp &bop) const

Static Public Attributes
static const cylindrical	null

Protected Member Functions
virtual vector	localToGlobal (const vector &local, bool translate) const

virtual tmp< vectorField >	localToGlobal (const vectorField &local, bool translate) const

virtual vector	globalToLocal (const vector &global, bool translate) const

virtual tmp< vectorField >	globalToLocal (const vectorField &global, bool translate) const

Protected Member Functions inherited from coordinateSystem
template<class PointField >
tmp< tensorField >	rotationsImpl (const PointField &global) const

template<class PointField >
tmp< pointField >	transformPointImpl (const PointField &localCart) const

template<class PointField >
tmp< pointField >	invTransformPointImpl (const PointField &global) const

template<class RetType , class PointField , class Type , class BinaryOp >
tmp< Field< RetType > >	oneToOneImpl (const PointField &global, const UList< Type > &input, const BinaryOp &bop) const

template<class RetType , class PointField , class Type , class BinaryOp >
tmp< Field< RetType > >	oneToManyImpl (const PointField &global, const Type &input, const BinaryOp &bop) const

void	assign (const dictionary &dict)

	coordinateSystem (std::nullptr_t)

Additional Inherited Members
Static Public Member Functions inherited from coordinateSystem
static autoPtr< coordinateSystem >	New (word modelType, const objectRegistry &obr, const dictionary &dict)

static autoPtr< coordinateSystem >	New (word modelType, const dictionary &dict)

static autoPtr< coordinateSystem >	New (const objectRegistry &obr, const dictionary &dict, const word &dictName="")

static autoPtr< coordinateSystem >	New (const dictionary &dict, const word &dictName="")

static autoPtr< coordinateSystem >	New (Istream &is)

Static Protected Member Functions inherited from coordinateSystem
template<class RetType , class Type , class BinaryOp >
static tmp< Field< RetType > >	manyTimesImpl (const tensor &tt, const UList< Type > &input, const BinaryOp &bop)

Protected Attributes inherited from coordinateSystem
autoPtr< coordinateRotation >	spec_

point	origin_

tensor	rot_

word	name_

string	note_

Static Protected Attributes inherited from coordinateSystem
static coordinateSystem	dummy_

Detailed Description

A cylindrical coordinate system (r-theta-z). The coordinate system angle theta is always in radians.

Dictionary entries

Property	Description	Required	Default
`type`	type name: cylindrical	yes

Source files

Definition at line 67 of file cylindricalCS.H.

Constructor & Destructor Documentation

◆ cylindrical() [1/15]

cylindrical ( )

Definition at line 84 of file cylindricalCS.C.

◆ cylindrical() [2/15]

cylindrical ( const cylindrical & csys )

default

◆ cylindrical() [3/15]

cylindrical ( cylindrical && csys )

default

◆ cylindrical() [4/15]

cylindrical ( const coordinateSystem & csys )

explicit

Definition at line 90 of file cylindricalCS.C.

◆ cylindrical() [5/15]

cylindrical ( coordinateSystem && csys )

explicit

Definition at line 96 of file cylindricalCS.C.

◆ cylindrical() [6/15]

cylindrical ( autoPtr< coordinateSystem > && csys )

explicit

Definition at line 102 of file cylindricalCS.C.

◆ cylindrical() [7/15]

cylindrical ( const coordinateRotation & crot )

explicit

Definition at line 108 of file cylindricalCS.C.

◆ cylindrical() [8/15]

cylindrical	(	const point &	origin,
		const coordinateRotation &	crot
	)

Definition at line 115 of file cylindricalCS.C.

◆ cylindrical() [9/15]

cylindrical	(	const point &	origin,
		const vector &	axis
	)

Definition at line 125 of file cylindricalCS.C.

◆ cylindrical() [10/15]

cylindrical	(	const word &	name,
		const point &	origin,
		const vector &	axis
	)

Definition at line 135 of file cylindricalCS.C.

◆ cylindrical() [11/15]

cylindrical	(	const point &	origin,
		const vector &	axis,
		const vector &	dirn
	)

Definition at line 151 of file cylindricalCS.C.

◆ cylindrical() [12/15]

cylindrical	(	const word &	name,
		const point &	origin,
		const vector &	axis,
		const vector &	dirn
	)

Definition at line 162 of file cylindricalCS.C.

◆ cylindrical() [13/15]

cylindrical	(	const word &	name,
		const dictionary &	dict
	)

Definition at line 174 of file cylindricalCS.C.

References dict, and Foam::warnCompatDegrees().

Here is the call graph for this function:

◆ cylindrical() [14/15]

cylindrical ( const dictionary & dict )

explicit

Definition at line 188 of file cylindricalCS.C.

References dict, and Foam::warnCompatDegrees().

Here is the call graph for this function:

◆ cylindrical() [15/15]

cylindrical	(	const dictionary &	dict,
		const word &	dictName
	)

Definition at line 200 of file cylindricalCS.C.

References dict, dictName(), dictionary::getOrDefault(), and Foam::warnCompatDegrees().

Here is the call graph for this function:

◆ ~cylindrical()

virtual ~cylindrical ( )

virtualdefault

Member Function Documentation

◆ localToGlobal() [1/2]

Foam::vector localToGlobal	(	const vector &	local,
		bool	translate
	)		const

protectedvirtual

Reimplemented from coordinateSystem.

Definition at line 258 of file cylindricalCS.C.

References coordinateSystem::localToGlobal(), and Foam::toCartesian().

Here is the call graph for this function:

◆ localToGlobal() [2/2]

Foam::tmp< Foam::vectorField > localToGlobal	(	const vectorField &	local,
		bool	translate
	)		const

protectedvirtual

Reimplemented from coordinateSystem.

Definition at line 272 of file cylindricalCS.C.

References coordinateSystem::localToGlobal(), tmp::New(), and Foam::toCartesian().

Here is the call graph for this function:

◆ globalToLocal() [1/2]

Foam::vector globalToLocal	(	const vector &	global,
		bool	translate
	)		const

protectedvirtual

Reimplemented from coordinateSystem.

Definition at line 297 of file cylindricalCS.C.

References Foam::fromCartesian(), and coordinateSystem::globalToLocal().

Here is the call graph for this function:

◆ globalToLocal() [2/2]

Foam::tmp< Foam::vectorField > globalToLocal	(	const vectorField &	global,
		bool	translate
	)		const

protectedvirtual

Reimplemented from coordinateSystem.

Definition at line 310 of file cylindricalCS.C.

References Foam::fromCartesian(), coordinateSystem::globalToLocal(), and tmp::ref().

Here is the call graph for this function:

◆ TypeNameNoDebug()

TypeNameNoDebug ( "cylindrical" )

◆ clone()

virtual autoPtr<coordinateSystem> clone ( ) const

inlinevirtual

Reimplemented from coordinateSystem.

Definition at line 181 of file cylindricalCS.H.

◆ uniform()

virtual bool uniform ( ) const

inlinevirtual

Reimplemented from coordinateSystem.

Definition at line 194 of file cylindricalCS.H.

◆ R() [1/5]

Foam::tensor R ( const point & global ) const

virtual

Reimplemented from coordinateSystem.

Definition at line 223 of file cylindricalCS.C.

References Tensor::col(), and Foam::mag().

Here is the call graph for this function:

◆ operator=() [1/2]

cylindrical& operator= ( const cylindrical & )

default

◆ operator=() [2/2]

cylindrical& operator= ( cylindrical && )

default

◆ R() [2/5]

virtual const tensor& R

inline

Definition at line 472 of file coordinateSystem.H.

◆ R() [3/5]

Foam::tensor R

Definition at line 288 of file coordinateSystem.C.

◆ R() [4/5]

Foam::tmp< Foam::tensorField > R

Definition at line 295 of file coordinateSystem.C.

◆ R() [5/5]

Foam::tmp< Foam::tensorField > R

Definition at line 304 of file coordinateSystem.C.

Member Data Documentation

◆ null

const Foam::coordSystem::cylindrical null

static

Definition at line 117 of file cylindricalCS.H.

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

src/meshTools/coordinate/systems/cylindricalCS.H
src/meshTools/coordinate/systems/cylindricalCS.C

Public Member Functions

Static Public Attributes

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ cylindrical() [1/15]

◆ cylindrical() [2/15]

◆ cylindrical() [3/15]

◆ cylindrical() [4/15]

◆ cylindrical() [5/15]

◆ cylindrical() [6/15]

◆ cylindrical() [7/15]

◆ cylindrical() [8/15]

◆ cylindrical() [9/15]

◆ cylindrical() [10/15]

◆ cylindrical() [11/15]

◆ cylindrical() [12/15]

◆ cylindrical() [13/15]

◆ cylindrical() [14/15]

◆ cylindrical() [15/15]

◆ ~cylindrical()

Member Function Documentation

◆ localToGlobal() [1/2]

◆ localToGlobal() [2/2]

◆ globalToLocal() [1/2]

◆ globalToLocal() [2/2]

◆ TypeNameNoDebug()

◆ clone()

◆ uniform()

◆ R() [1/5]

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ R() [2/5]

◆ R() [3/5]

◆ R() [4/5]

◆ R() [5/5]

Member Data Documentation

◆ null