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

#include <cylindricalCS.H>

Inheritance diagram for cylindrical:

Collaboration diagram for cylindrical:

[legend]

Public Member Functions
	TypeNameNoDebug ("cylindrical")
	Runtime type information.
	cylindrical ()=default
	Default construct. Identity coordinate system.
	cylindrical (const cylindrical &csys)=default
	Copy construct.
	cylindrical (cylindrical &&csys)=default
	Move construct.
	cylindrical (const coordinateSystem &csys)
	Copy construct from another coordinateSystem type.
	cylindrical (coordinateSystem &&csys)
	Move construct from another coordinateSystem type.
	cylindrical (autoPtr< coordinateSystem > &&csys)
	Move construct from autoPtr of another coordinateSystem type.
	cylindrical (const coordinateRotation &crot)
	Copy construct from rotation with origin=0.
	cylindrical (const point &origin, const coordinateRotation &crot)
	Construct from origin and rotation.
	cylindrical (const point &origin, const vector &axis)
	Construct from origin and single axis.
	cylindrical (const word &name, const point &origin, const vector &axis)
	Construct named from origin and single axis.
	cylindrical (const point &origin, const vector &axis, const vector &dirn)
	Construct from origin and two axes.
	cylindrical (const word &name, const point &origin, const vector &axis, const vector &dirn)
	Construct named from origin and two axes.
	cylindrical (const dictionary &dict, IOobjectOption::readOption readOrigin=IOobjectOption::MUST_READ)
	Construct from dictionary with optional read handling for the 'origin' entry (default: MUST_READ).
	cylindrical (const dictionary &dict, const word &dictName, IOobjectOption::readOption readOrigin=IOobjectOption::MUST_READ)
	Construct from dictionary with optional subDict lookup and optional read handling for the 'origin' entry (default: MUST_READ).
virtual autoPtr< coordinateSystem >	clone () const
	Return clone.
virtual	~cylindrical ()=default
	Destructor.
virtual bool	uniform () const
	Treat the rotation tensor as non-uniform.
virtual tensor	R (const point &global) const
	Position-dependent rotation tensor at a single point.
cylindrical &	operator= (const cylindrical &)=default
	Copy assignment.
cylindrical &	operator= (cylindrical &&)=default
	Move assignment.
virtual const tensor &	R () const
	Position-dependent rotation tensors at multiple points.
virtual tmp< tensorField >	R (const UList< point > &global) const
	Position-dependent rotation tensors at multiple points.
virtual tmp< tensorField >	R (const pointUIndList &global) const
	Position-dependent rotation tensors at multiple points.
Public Member Functions inherited from coordinateSystem
	TypeName ("coordinateSystem")
	Runtime type information.
	coordinateSystem ()
	Default construct. This is an identity coordinate system.
	coordinateSystem (const coordinateRotation &crot)
	Copy construct from rotation with origin=0.
	coordinateSystem (coordinateRotation &&crot)
	Move construct from rotation with origin=0.
	coordinateSystem (const coordinateSystem &csys)
	Copy construct.
	coordinateSystem (coordinateSystem &&csys)
	Move construct.
	coordinateSystem (autoPtr< coordinateSystem > &&csys)
	Move construct from autoPtr.
	coordinateSystem (const word &name, const coordinateSystem &csys)
	Copy construct with a different name.
	coordinateSystem (const point &origin, const coordinateRotation &crot)
	Construct from origin and rotation.
	coordinateSystem (const point &origin, const vector &axis, const vector &dirn)
	Construct from origin and 2 axes.
	coordinateSystem (const word &name, const point &origin, const coordinateRotation &crot)
	Construct from origin and rotation.
	coordinateSystem (const word &name, const point &origin, const vector &axis, const vector &dirn)
	Construct named from origin and 2 axes.
	coordinateSystem (const dictionary &dict, IOobjectOption::readOption readOrigin=IOobjectOption::MUST_READ)
	Construct from dictionary with optional read handling for the 'origin' entry (default: MUST_READ).
	coordinateSystem (const dictionary &dict, const word &dictName, IOobjectOption::readOption readOrigin=IOobjectOption::MUST_READ)
	Construct from dictionary with optional subDict lookup and optional read handling for the 'origin' entry (default: MUST_READ).
	declareRunTimeSelectionTable (autoPtr, coordinateSystem, dictionary,(const dictionary &dict, IOobjectOption::readOption readOrigin),(dict, readOrigin))
	declareRunTimeSelectionTable (autoPtr, coordinateSystem, registry,(const objectRegistry &obr, const dictionary &dict, IOobjectOption::readOption readOrigin),(obr, dict, readOrigin))
virtual	~coordinateSystem ()=default
	Destructor.
virtual bool	good () const
	Consider good if it has a specification.
virtual bool	valid () const
	Same as good() - 2023-07.
virtual const point &	origin () const
	Return origin.
virtual const coordinateRotation &	rotation () const
	The rotation specification.
virtual const word &	name () const
	Return the name.
virtual const string &	note () const
	Return the optional note.
virtual const vector	e1 () const
	The local Cartesian x-axis in global coordinates.
virtual const vector	e2 () const
	The local Cartesian y-axis in global coordinates.
virtual const vector	e3 () const
	The local Cartesian z-axis in global coordinates.
virtual void	rename (const word &newName)
	Rename.
virtual string &	note ()
	Edit access to optional note.
virtual point &	origin ()
	Edit access to origin.
virtual void	clear ()
	Reset origin and rotation to an identity coordinateSystem.
virtual void	rotation (autoPtr< coordinateRotation > &&crot)
	Change the rotation.
virtual void	write (Ostream &os) const
	Write.
virtual void	writeEntry (Ostream &os) const
	Write 'coordinateSystem' dictionary entry.
virtual void	writeEntry (const word &keyword, Ostream &os) const
	Write dictionary entry.
void	operator= (const coordinateSystem &csys)
	Copy assignment.
void	operator= (coordinateSystem &&csys)
	Move assignment.
void	operator= (const autoPtr< coordinateSystem > &csys)
	Copy assignment from autoPtr.
void	operator= (autoPtr< coordinateSystem > &&csys)
	Move assignment from autoPtr.
point	transformPoint (const point &localCart) const
	Transform point and add origin offset.
tmp< pointField >	transformPoint (const UList< point > &localCart) const
	Transform points and add origin offset.
tmp< pointField >	transformPoint (const pointUIndList &localCart) const
	Transform points and add origin offset.
point	invTransformPoint (const point &global) const
	Remove origin offset and inverse transform point.
tmp< pointField >	invTransformPoint (const UList< point > &global) const
	Remove origin offset and inverse transform points.
tmp< pointField >	invTransformPoint (const pointUIndList &global) const
	Remove origin offset and inverse transform points.
point	globalPosition (const point &local) const
	From local coordinate position to global (cartesian) position.
tmp< pointField >	globalPosition (const pointField &local) const
	From local coordinate position to global (cartesian) position.
point	localPosition (const point &global) const
	From global (cartesian) position to local coordinate position.
tmp< pointField >	localPosition (const pointField &global) const
	From global (cartesian) position to local coordinate position.
vector	globalVector (const vector &local) const
	From local to global (cartesian) vector components.
tmp< vectorField >	globalVector (const vectorField &local) const
	From local to global (cartesian) vector components.
vector	localVector (const vector &global) const
	From global (cartesian) to local vector components.
tmp< vectorField >	localVector (const vectorField &global) const
	From global (cartesian) to local vector components.
virtual symmTensor	transformPrincipal (const vector &input) const
	With constant rotation tensor.
virtual tmp< Field< symmTensor > >	transformPrincipal (const UList< vector > &input) const
	With constant rotation tensor.
virtual symmTensor	transformPrincipal (const point &global, const vector &input) const
	With rotation tensor at given global position.
virtual tmp< Field< symmTensor > >	transformPrincipal (const UList< point > &global, const vector &input) const
	With rotation tensors at given global positions.
virtual tmp< Field< symmTensor > >	transformPrincipal (const pointUIndList &global, const vector &input) const
	With rotation tensors at given global positions.
virtual tmp< Field< symmTensor > >	transformPrincipal (const UList< point > &global, const UList< vector > &input) const
	With rotation tensors at given global positions.
virtual tmp< Field< symmTensor > >	transformPrincipal (const pointUIndList &global, const UList< vector > &input) const
	With rotation tensors at given global positions.
virtual scalar	transform (const scalar &input) const
	With constant rotation tensor.
virtual tmp< Field< scalar > >	transform (const UList< scalar > &input) const
	With constant rotation tensor.
virtual scalar	transform (const point &global, const scalar &input) const
	With rotation tensor at given global position.
virtual tmp< Field< scalar > >	transform (const UList< point > &global, const scalar &input) const
	With rotation tensors at given global positions.
virtual tmp< Field< scalar > >	transform (const pointUIndList &global, const scalar &input) const
	With rotation tensors at given global positions.
virtual tmp< Field< scalar > >	transform (const UList< point > &global, const UList< scalar > &input) const
	With rotation tensors at given global positions.
virtual tmp< Field< scalar > >	transform (const pointUIndList &global, const UList< scalar > &input) const
	With rotation tensors at given global positions.
virtual vector	transform (const vector &input) const
	With constant rotation tensor.
virtual tmp< Field< vector > >	transform (const UList< vector > &input) const
	With constant rotation tensor.
virtual vector	transform (const point &global, const vector &input) const
	With rotation tensor at given global position.
virtual tmp< Field< vector > >	transform (const UList< point > &global, const vector &input) const
	With rotation tensors at given global positions.
virtual tmp< Field< vector > >	transform (const pointUIndList &global, const vector &input) const
	With rotation tensors at given global positions.
virtual tmp< Field< vector > >	transform (const UList< point > &global, const UList< vector > &input) const
	With rotation tensors at given global positions.
virtual tmp< Field< vector > >	transform (const pointUIndList &global, const UList< vector > &input) const
	With rotation tensors at given global positions.
virtual sphericalTensor	transform (const sphericalTensor &input) const
	With constant rotation tensor.
virtual tmp< Field< sphericalTensor > >	transform (const UList< sphericalTensor > &input) const
	With constant rotation tensor.
virtual sphericalTensor	transform (const point &global, const sphericalTensor &input) const
	With rotation tensor at given global position.
virtual tmp< Field< sphericalTensor > >	transform (const UList< point > &global, const sphericalTensor &input) const
	With rotation tensors at given global positions.
virtual tmp< Field< sphericalTensor > >	transform (const pointUIndList &global, const sphericalTensor &input) const
	With rotation tensors at given global positions.
virtual tmp< Field< sphericalTensor > >	transform (const UList< point > &global, const UList< sphericalTensor > &input) const
	With rotation tensors at given global positions.
virtual tmp< Field< sphericalTensor > >	transform (const pointUIndList &global, const UList< sphericalTensor > &input) const
	With rotation tensors at given global positions.
virtual symmTensor	transform (const symmTensor &input) const
	With constant rotation tensor.
virtual tmp< Field< symmTensor > >	transform (const UList< symmTensor > &input) const
	With constant rotation tensor.
virtual symmTensor	transform (const point &global, const symmTensor &input) const
	With rotation tensor at given global position.
virtual tmp< Field< symmTensor > >	transform (const UList< point > &global, const symmTensor &input) const
	With rotation tensors at given global positions.
virtual tmp< Field< symmTensor > >	transform (const pointUIndList &global, const symmTensor &input) const
	With rotation tensors at given global positions.
virtual tmp< Field< symmTensor > >	transform (const UList< point > &global, const UList< symmTensor > &input) const
	With rotation tensors at given global positions.
virtual tmp< Field< symmTensor > >	transform (const pointUIndList &global, const UList< symmTensor > &input) const
	With rotation tensors at given global positions.
virtual tensor	transform (const tensor &input) const
	With constant rotation tensor.
virtual tmp< Field< tensor > >	transform (const UList< tensor > &input) const
	With constant rotation tensor.
virtual tensor	transform (const point &global, const tensor &input) const
	With rotation tensor at given global position.
virtual tmp< Field< tensor > >	transform (const UList< point > &global, const tensor &input) const
	With rotation tensors at given global positions.
virtual tmp< Field< tensor > >	transform (const pointUIndList &global, const tensor &input) const
	With rotation tensors at given global positions.
virtual tmp< Field< tensor > >	transform (const UList< point > &global, const UList< tensor > &input) const
	With rotation tensors at given global positions.
virtual tmp< Field< tensor > >	transform (const pointUIndList &global, const UList< tensor > &input) const
	With rotation tensors at given global positions.
virtual scalar	invTransform (const scalar &input) const
	With constant rotation tensor.
virtual tmp< Field< scalar > >	invTransform (const UList< scalar > &input) const
	With constant rotation tensor.
virtual scalar	invTransform (const point &global, const scalar &input) const
	With rotation tensor at given global position.
virtual tmp< Field< scalar > >	invTransform (const UList< point > &global, const scalar &input) const
	With rotation tensors at given global positions.
virtual tmp< Field< scalar > >	invTransform (const pointUIndList &global, const scalar &input) const
	With rotation tensors at given global positions.
virtual tmp< Field< scalar > >	invTransform (const UList< point > &global, const UList< scalar > &input) const
	With rotation tensors at given global positions.
virtual tmp< Field< scalar > >	invTransform (const pointUIndList &global, const UList< scalar > &input) const
	With rotation tensors at given global positions.
virtual vector	invTransform (const vector &input) const
	With constant rotation tensor.
virtual tmp< Field< vector > >	invTransform (const UList< vector > &input) const
	With constant rotation tensor.
virtual vector	invTransform (const point &global, const vector &input) const
	With rotation tensor at given global position.
virtual tmp< Field< vector > >	invTransform (const UList< point > &global, const vector &input) const
	With rotation tensors at given global positions.
virtual tmp< Field< vector > >	invTransform (const pointUIndList &global, const vector &input) const
	With rotation tensors at given global positions.
virtual tmp< Field< vector > >	invTransform (const UList< point > &global, const UList< vector > &input) const
	With rotation tensors at given global positions.
virtual tmp< Field< vector > >	invTransform (const pointUIndList &global, const UList< vector > &input) const
	With rotation tensors at given global positions.
virtual sphericalTensor	invTransform (const sphericalTensor &input) const
	With constant rotation tensor.
virtual tmp< Field< sphericalTensor > >	invTransform (const UList< sphericalTensor > &input) const
	With constant rotation tensor.
virtual sphericalTensor	invTransform (const point &global, const sphericalTensor &input) const
	With rotation tensor at given global position.
virtual tmp< Field< sphericalTensor > >	invTransform (const UList< point > &global, const sphericalTensor &input) const
	With rotation tensors at given global positions.
virtual tmp< Field< sphericalTensor > >	invTransform (const pointUIndList &global, const sphericalTensor &input) const
	With rotation tensors at given global positions.
virtual tmp< Field< sphericalTensor > >	invTransform (const UList< point > &global, const UList< sphericalTensor > &input) const
	With rotation tensors at given global positions.
virtual tmp< Field< sphericalTensor > >	invTransform (const pointUIndList &global, const UList< sphericalTensor > &input) const
	With rotation tensors at given global positions.
virtual symmTensor	invTransform (const symmTensor &input) const
	With constant rotation tensor.
virtual tmp< Field< symmTensor > >	invTransform (const UList< symmTensor > &input) const
	With constant rotation tensor.
virtual symmTensor	invTransform (const point &global, const symmTensor &input) const
	With rotation tensor at given global position.
virtual tmp< Field< symmTensor > >	invTransform (const UList< point > &global, const symmTensor &input) const
	With rotation tensors at given global positions.
virtual tmp< Field< symmTensor > >	invTransform (const pointUIndList &global, const symmTensor &input) const
	With rotation tensors at given global positions.
virtual tmp< Field< symmTensor > >	invTransform (const UList< point > &global, const UList< symmTensor > &input) const
	With rotation tensors at given global positions.
virtual tmp< Field< symmTensor > >	invTransform (const pointUIndList &global, const UList< symmTensor > &input) const
	With rotation tensors at given global positions.
virtual tensor	invTransform (const tensor &input) const
	With constant rotation tensor.
virtual tmp< Field< tensor > >	invTransform (const UList< tensor > &input) const
	With constant rotation tensor.
virtual tensor	invTransform (const point &global, const tensor &input) const
	With rotation tensor at given global position.
virtual tmp< Field< tensor > >	invTransform (const UList< point > &global, const tensor &input) const
	With rotation tensors at given global positions.
virtual tmp< Field< tensor > >	invTransform (const pointUIndList &global, const tensor &input) const
	With rotation tensors at given global positions.
virtual tmp< Field< tensor > >	invTransform (const UList< point > &global, const UList< tensor > &input) const
	With rotation tensors at given global positions.
virtual tmp< Field< tensor > >	invTransform (const pointUIndList &global, const UList< tensor > &input) const
	With rotation tensors at given global positions.
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
	Global (identity) cylindrical coordinate system.

Protected Member Functions
virtual vector	localToGlobal (const vector &local, bool translate) const
	From local coordinate system to the global Cartesian system with optional translation for the origin.
virtual tmp< vectorField >	localToGlobal (const vectorField &local, bool translate) const
	From local coordinate system to the global Cartesian system with optional translation for the origin.
virtual vector	globalToLocal (const vector &global, bool translate) const
	From global Cartesian system to the local coordinate system with optional translation for the origin.
virtual tmp< vectorField >	globalToLocal (const vectorField &global, bool translate) const
	Convert from global Cartesian system to the local coordinate system with optional translation for the origin.
Protected Member Functions inherited from coordinateSystem
template<class PointField>
tmp< tensorField >	rotationsImpl (const PointField &global) const
	Implementation for R() methods.
template<class PointField>
tmp< pointField >	transformPointImpl (const PointField &localCart) const
	Implementation for transformPoint() methods.
template<class PointField>
tmp< pointField >	invTransformPointImpl (const PointField &global) const
	Implementation for transformPosition() methods.
template<class RetType, class PointField, class Type, class BinaryOp>
tmp< Field< RetType > >	oneToOneImpl (const PointField &global, const UList< Type > &input, const BinaryOp &bop) const
	Use position-dependent transform tensors for multiple inputs.
template<class RetType, class PointField, class Type, class BinaryOp>
tmp< Field< RetType > >	oneToManyImpl (const PointField &global, const Type &input, const BinaryOp &bop) const
	Use position-dependent transform tensors for single input.
void	assign (const dictionary &dict, IOobjectOption::readOption readOrigin=IOobjectOption::MUST_READ)
	Assign from dictionary content with specified read handling of the 'origin' entry.
	coordinateSystem (std::nullptr_t)
	Construct null, without allocating a coordinateRotation specification.

Additional Inherited Members
Static Public Member Functions inherited from coordinateSystem
template<class Derived>
static autoPtr< coordinateSystem >	Clone (const Derived &csys)
	Clone a coordinate system.
static autoPtr< coordinateSystem >	Clone (const word &modelType, const objectRegistry &obr, const dictionary &dict, IOobjectOption::readOption readOrigin=IOobjectOption::MUST_READ)
	Select construct the specified coordinate system type with reference to objectRegistry for indirect entries.
static autoPtr< coordinateSystem >	New (const word &modelType, const objectRegistry &obr, const dictionary &dict, IOobjectOption::readOption readOrigin=IOobjectOption::MUST_READ)
	Select construct the specified coordinate system type with reference to objectRegistry for indirect entries.
static autoPtr< coordinateSystem >	New (const word &modelType, const dictionary &dict, IOobjectOption::readOption readOrigin=IOobjectOption::MUST_READ)
	Select construct the specified coordinate system type.
static autoPtr< coordinateSystem >	New (const objectRegistry &obr, const dictionary &dict, const word &dictName=word::null, IOobjectOption::readOption readOrigin=IOobjectOption::MUST_READ)
	Select construct from dictionary with reference to objectRegistry for indirect entries.
static autoPtr< coordinateSystem >	New (const dictionary &dict, const word &dictName=word::null, IOobjectOption::readOption readOrigin=IOobjectOption::MUST_READ)
	Select constructed from dictionary.
static autoPtr< coordinateSystem >	New (Istream &is, IOobjectOption::readOption readOrigin=IOobjectOption::MUST_READ)
	Select constructed from Istream.
static autoPtr< coordinateSystem >	NewIfPresent (const objectRegistry &obr, const dictionary &dict, const word &dictName=coordinateSystem::typeName)
	Optional select construct from dictionary, with registry reference.
static autoPtr< coordinateSystem >	NewIfPresent (const dictionary &dict, const word &dictName=coordinateSystem::typeName)
	Optional select construct from dictionary.
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)
	Apply single transform tensor for multiple inputs.
Protected Attributes inherited from coordinateSystem
autoPtr< coordinateRotation >	spec_
	User specification of the coordinate rotation.
point	origin_
	The coordinate system origin.
tensor	rot_
	The rotation tensor.
word	name_
	The name of the coordinate system (optional).
string	note_
	An optional note describing the coordinate system.
Static Protected Attributes inherited from coordinateSystem
static coordinateSystem	dummy_
	Dummy coordinate system for suppressed manipulation.

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/14]

cylindrical ( )

default

Default construct. Identity coordinate system.

Referenced by cylindrical(), cylindrical(), cylindrical(), cylindrical(), cylindrical(), operator=(), and operator=().

Here is the caller graph for this function:

◆ cylindrical() [2/14]

cylindrical ( const cylindrical & csys )

default

Copy construct.

References cylindrical().

Here is the call graph for this function:

◆ cylindrical() [3/14]

cylindrical ( cylindrical && csys )

default

Move construct.

References coordinateSystem::coordinateSystem(), cylindrical(), dict, dictName(), IOobjectOption::MUST_READ, coordinateSystem::name(), and coordinateSystem::origin().

Here is the call graph for this function:

◆ cylindrical() [4/14]

cylindrical ( const coordinateSystem & csys )

explicit

Copy construct from another coordinateSystem type.

Definition at line 84 of file cylindricalCS.C.

References coordinateSystem::coordinateSystem().

Here is the call graph for this function:

◆ cylindrical() [5/14]

cylindrical ( coordinateSystem && csys )

explicit

Move construct from another coordinateSystem type.

Definition at line 90 of file cylindricalCS.C.

References coordinateSystem::coordinateSystem().

Here is the call graph for this function:

◆ cylindrical() [6/14]

cylindrical ( autoPtr< coordinateSystem > && csys )

explicit

Move construct from autoPtr of another coordinateSystem type.

Definition at line 96 of file cylindricalCS.C.

References coordinateSystem::coordinateSystem().

Here is the call graph for this function:

◆ cylindrical() [7/14]

cylindrical ( const coordinateRotation & crot )

explicit

Copy construct from rotation with origin=0.

Definition at line 102 of file cylindricalCS.C.

References coordinateSystem::coordinateSystem().

Here is the call graph for this function:

◆ cylindrical() [8/14]

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

Construct from origin and rotation.

Definition at line 108 of file cylindricalCS.C.

References coordinateSystem::coordinateSystem(), and coordinateSystem::origin().

Here is the call graph for this function:

◆ cylindrical() [9/14]

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

Construct from origin and single axis.

Definition at line 118 of file cylindricalCS.C.

References cylindrical(), null, and coordinateSystem::origin().

Here is the call graph for this function:

◆ cylindrical() [10/14]

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

Construct named from origin and single axis.

Definition at line 128 of file cylindricalCS.C.

References coordinateSystem::coordinateSystem(), cylindrical(), coordinateSystem::name(), and coordinateSystem::origin().

Here is the call graph for this function:

◆ cylindrical() [11/14]

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

Construct from origin and two axes.

Definition at line 144 of file cylindricalCS.C.

References cylindrical(), null, and coordinateSystem::origin().

Here is the call graph for this function:

◆ cylindrical() [12/14]

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

Construct named from origin and two axes.

Definition at line 155 of file cylindricalCS.C.

References coordinateSystem::coordinateSystem(), coordinateSystem::name(), and coordinateSystem::origin().

Here is the call graph for this function:

◆ cylindrical() [13/14]

cylindrical	(	const dictionary &	dict,
		IOobjectOption::readOption	readOrigin = IOobjectOption::MUST_READ )

explicit

Construct from dictionary with optional read handling for the 'origin' entry (default: MUST_READ).

Note: The readOrigin is downgraded to READ_IF_PRESENT if the dictionary itself is "coordinateSystem"

Definition at line 167 of file cylindricalCS.C.

References coordinateSystem::coordinateSystem(), dict, and Foam::warnCompatDegrees().

Here is the call graph for this function:

◆ cylindrical() [14/14]

cylindrical	(	const dictionary &	dict,
		const word &	dictName,
		IOobjectOption::readOption	readOrigin = IOobjectOption::MUST_READ )

Construct from dictionary with optional subDict lookup and optional read handling for the 'origin' entry (default: MUST_READ).

Parameters

dictName If non-empty, mandatory sub-dictionary to use.

Note: The readOrigin is downgraded to READ_IF_PRESENT if the dictionary itself is "coordinateSystem" or if a sub-dictionary is being used

Definition at line 179 of file cylindricalCS.C.

References coordinateSystem::coordinateSystem(), dict, and dictName().

Here is the call graph for this function:

◆ ~cylindrical()

virtual ~cylindrical ( )

virtualdefault

Destructor.

Member Function Documentation

◆ localToGlobal() [1/2]

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

protectedvirtual

From local coordinate system to the global Cartesian system with optional translation for the origin.

Reimplemented from coordinateSystem.

Definition at line 234 of file cylindricalCS.C.

References local, 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

From local coordinate system to the global Cartesian system with optional translation for the origin.

Reimplemented from coordinateSystem.

Definition at line 248 of file cylindricalCS.C.

References local, coordinateSystem::localToGlobal(), tmp< T >::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

From global Cartesian system to the local coordinate system with optional translation for the origin.

Reimplemented from coordinateSystem.

Definition at line 273 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

Convert from global Cartesian system to the local coordinate system with optional translation for the origin.

Reimplemented from coordinateSystem.

Definition at line 286 of file cylindricalCS.C.

References Foam::fromCartesian(), coordinateSystem::globalToLocal(), tmp< T >::ref(), and UList< T >::size().

Here is the call graph for this function:

◆ TypeNameNoDebug()

TypeNameNoDebug ( "cylindrical" )

Runtime type information.

◆ clone()

virtual autoPtr< coordinateSystem > clone ( ) const

inlinevirtual

Return clone.

Reimplemented from coordinateSystem.

Definition at line 241 of file cylindricalCS.H.

References coordinateSystem::Clone().

Here is the call graph for this function:

◆ uniform()

virtual bool uniform ( ) const

inlinevirtual

Treat the rotation tensor as non-uniform.

Reimplemented from coordinateSystem.

Definition at line 258 of file cylindricalCS.H.

◆ R() [1/4]

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

virtual

Position-dependent rotation tensor at a single point.

Returns: tensor

Reimplemented from coordinateSystem.

Definition at line 201 of file cylindricalCS.C.

References Tensor< Cmpt >::col(), Foam::mag(), coordinateSystem::origin_, Vector< Cmpt >::removeCollinear(), and coordinateSystem::rot_.

Here is the call graph for this function:

◆ operator=() [1/2]

cylindrical & operator= ( const cylindrical & )

default

Copy assignment.

References cylindrical().

Here is the call graph for this function:

◆ operator=() [2/2]

cylindrical & operator= ( cylindrical && )

default

Move assignment.

References cylindrical().

Here is the call graph for this function:

◆ R() [2/4]

virtual const tensor & R ( ) const

inlinevirtual

Position-dependent rotation tensors at multiple points.

Reimplemented from coordinateSystem.

Definition at line 740 of file coordinateSystem.H.

◆ R() [3/4]

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

virtual

Position-dependent rotation tensors at multiple points.

Reimplemented from coordinateSystem.

Definition at line 862 of file coordinateSystem.C.

◆ R() [4/4]

Foam::tmp< Foam::tensorField > R ( const pointUIndList & global ) const

virtual

Position-dependent rotation tensors at multiple points.

Reimplemented from coordinateSystem.

Definition at line 868 of file coordinateSystem.C.

Member Data Documentation

◆ null

const Foam::coordSystem::cylindrical null

static

Global (identity) cylindrical coordinate system.

Definition at line 129 of file cylindricalCS.H.

Referenced by cylindrical(), and cylindrical().

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

src/OpenFOAM/primitives/coordinate/systems/cylindricalCS.H
src/OpenFOAM/primitives/coordinate/systems/cylindricalCS.C

Public Member Functions

Static Public Attributes

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ cylindrical() [1/14]

◆ cylindrical() [2/14]

◆ cylindrical() [3/14]

◆ cylindrical() [4/14]

◆ cylindrical() [5/14]

◆ cylindrical() [6/14]

◆ cylindrical() [7/14]

◆ cylindrical() [8/14]

◆ cylindrical() [9/14]

◆ cylindrical() [10/14]

◆ cylindrical() [11/14]

◆ cylindrical() [12/14]

◆ cylindrical() [13/14]

◆ cylindrical() [14/14]

◆ ~cylindrical()

Member Function Documentation

◆ localToGlobal() [1/2]

◆ localToGlobal() [2/2]

◆ globalToLocal() [1/2]

◆ globalToLocal() [2/2]

◆ TypeNameNoDebug()

◆ clone()

◆ uniform()

◆ R() [1/4]

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ R() [2/4]

◆ R() [3/4]

◆ R() [4/4]

Member Data Documentation

◆ null