Cylindrical coordinate system. More...

#include <meshTools/cylindricalCS.H>

Detailed Description

Cylindrical coordinate system.

Source files

Definition at line 50 of file cylindricalCS.H.

Inheritance diagram for cylindricalCS:

Collaboration diagram for cylindricalCS:

List of all members.

Public Member Functions
	TypeName ("cylindrical")
	Runtime type information.
	cylindricalCS (const bool inDegrees=true)
	Construct null.
	cylindricalCS (const coordinateSystem &, const bool inDegrees=true)
	Construct copy.
	cylindricalCS (const word &name, const coordinateSystem &, const bool inDegrees=true)
	Construct copy with a different name.
	cylindricalCS (const word &name, const point &origin, const coordinateRotation &, const bool inDegrees=true)
	Construct from origin and rotation.
	cylindricalCS (const word &name, const point &origin, const vector &axis, const vector &dirn, const bool inDegrees=true)
	Construct from origin and 2 axes.
	cylindricalCS (const word &name, const dictionary &)
	Construct from dictionary.
bool	inDegrees () const
	Are angles in degrees?
bool &	inDegrees ()
	Non-const access to inDegrees.
Public Member Functions inherited from coordinateSystem
	TypeName ("coordinateSystem")
	Runtime type information.
	coordinateSystem ()
	Construct null. This is equivalent to an identity coordinateSystem.
	coordinateSystem (const word &name, const coordinateSystem &)
	Construct copy with a different name.
	coordinateSystem (const word &name, const point &origin, const coordinateRotation &)
	Construct from origin and rotation.
	coordinateSystem (const word &name, const point &origin, const vector &axis, const vector &dirn)
	Construct from origin and 2 axes.
	coordinateSystem (const word &name, const dictionary &)
	Construct from dictionary with a given name.
	coordinateSystem (const dictionary &)
	Construct from dictionary with default name.
	coordinateSystem (const dictionary &, const objectRegistry &)
	Construct from dictionary (default name)
	coordinateSystem (Istream &)
	Construct from Istream.
autoPtr< coordinateSystem >	clone () const
	Return clone.
	declareRunTimeSelectionTable (autoPtr, coordinateSystem, dictionary,(const word &name, const dictionary &dict),(name, dict))
	declareRunTimeSelectionTable (autoPtr, coordinateSystem, origRotation,(const word &name, const point &origin, const coordinateRotation &cr),(name, origin, cr))
virtual	~coordinateSystem ()
const word &	name () const
	Return name.
string &	note ()
	Return non-constant access to the optional note.
const string &	note () const
	Return the optional note.
const point &	origin () const
	Return origin.
const coordinateRotation &	rotation () const
	Return coordinate rotation.
const tensor &	R () const
	Return local-to-global transformation tensor.
const vector	e1 () const
	Return local Cartesian x-axis.
const vector	e2 () const
	Return local Cartesian y-axis.
const vector	e3 () const
	Return local Cartesian z-axis.
const vector	axis () const
	Return axis (e3: local Cartesian z-axis)
const vector	direction () const
	Return direction (e1: local Cartesian x-axis)
virtual dictionary	dict (bool ignoreType=false) const
	Return as dictionary of entries.
virtual void	rename (const word &newName)
	Rename.
point &	origin ()
	Edit access to origin.
virtual void	write (Ostream &) const
	Write.
virtual void	writeDict (Ostream &, bool subDict=true) const
	Write dictionary.
point	globalPosition (const point &local) const
	Convert from position in local coordinate system to global Cartesian position.
tmp< pointField >	globalPosition (const pointField &local) const
	Convert from position in local coordinate system to global Cartesian position.
vector	globalVector (const vector &local) const
	Convert from vector components in local coordinate system to global Cartesian vector.
tmp< vectorField >	globalVector (const vectorField &local) const
	Convert from vector components in local coordinate system to global Cartesian vector.
point	localPosition (const point &global) const
	Convert from global Cartesian position to position in local coordinate system.
tmp< pointField >	localPosition (const pointField &global) const
	Convert from global Cartesian position to position in local coordinate system.
vector	localVector (const vector &global) const
	Convert from global Cartesian vector to components in local coordinate system.
tmp< vectorField >	localVector (const vectorField &global) const
	Convert from global Cartesian vector to components in local coordinate system.
void	operator= (const dictionary &)
	assign from dictionary

Protected Member Functions
virtual vector	localToGlobal (const vector &, bool translate) const
	Convert from local coordinate system to the global Cartesian system.
virtual tmp< vectorField >	localToGlobal (const vectorField &, bool translate) const
	Convert from local coordinate system to the global Cartesian system.
virtual vector	globalToLocal (const vector &, bool translate) const
	Convert from global Cartesian system to the local coordinate system.
virtual tmp< vectorField >	globalToLocal (const vectorField &, bool translate) const
	Convert from global Cartesian system to the local coordinate system.

Additional Inherited Members
Static Public Member Functions inherited from coordinateSystem
static autoPtr< coordinateSystem >	New (const word &name, const dictionary &)
	Select constructed from dictionary.
static autoPtr< coordinateSystem >	New (const word &coordType, const word &name, const point &origin, const coordinateRotation &)
	Select constructed from origin and rotation.
static autoPtr< coordinateSystem >	New (Istream &is)
	Select constructed from Istream.

Constructor & Destructor Documentation

cylindricalCS ( const bool inDegrees = true )

Construct null.

Definition at line 45 of file cylindricalCS.C.

cylindricalCS	(	const coordinateSystem &	cs,
		const bool	inDegrees = `true`
	)

Construct copy.

Definition at line 53 of file cylindricalCS.C.

cylindricalCS	(	const word &	name,
		const coordinateSystem &	cs,
		const bool	inDegrees = `true`
	)

Construct copy with a different name.

Definition at line 64 of file cylindricalCS.C.

cylindricalCS	(	const word &	name,
		const point &	origin,
		const coordinateRotation &	cr,
		const bool	inDegrees = `true`
	)

Construct from origin and rotation.

Definition at line 76 of file cylindricalCS.C.

cylindricalCS	(	const word &	name,
		const point &	origin,
		const vector &	axis,
		const vector &	dirn,
		const bool	inDegrees = `true`
	)

Construct from origin and 2 axes.

Definition at line 89 of file cylindricalCS.C.

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

Construct from dictionary.

Definition at line 103 of file cylindricalCS.C.

Member Function Documentation

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

protectedvirtual

Convert from local coordinate system to the global Cartesian system.

with optional translation for the origin

Reimplemented from coordinateSystem.

Definition at line 128 of file cylindricalCS.C.

References Foam::cos(), coordinateSystem::localToGlobal(), Foam::mathematicalConstant::pi(), Foam::sin(), Vector< Cmpt >::x(), Vector< Cmpt >::y(), and Vector< Cmpt >::z().

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

protectedvirtual

Convert from local coordinate system to the global Cartesian system.

with optional translation for the origin

Reimplemented from coordinateSystem.

Definition at line 147 of file cylindricalCS.C.

References Field< Type >::component(), Foam::cos(), coordinateSystem::localToGlobal(), Foam::mathematicalConstant::pi(), Field< Type >::replace(), Foam::sin(), List< T >::size(), Vector< scalar >::X, Vector< scalar >::Y, and Vector< scalar >::Z.

Foam::vector globalToLocal	(	const vector &	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 169 of file cylindricalCS.C.

References Foam::atan2(), coordinateSystem::globalToLocal(), Foam::mathematicalConstant::pi(), Foam::sqr(), Foam::sqrt(), Vector< Cmpt >::x(), Vector< Cmpt >::y(), and Vector< Cmpt >::z().

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 190 of file cylindricalCS.C.

References Foam::atan2(), Field< Type >::component(), coordinateSystem::globalToLocal(), Foam::mathematicalConstant::pi(), Field< Type >::replace(), List< T >::size(), Foam::sqr(), Foam::sqrt(), Vector< scalar >::X, Vector< scalar >::Y, and Vector< scalar >::Z.

TypeName ( "cylindrical" )

Runtime type information.

bool inDegrees ( ) const

Are angles in degrees?

Definition at line 115 of file cylindricalCS.C.

bool & inDegrees ( )

Non-const access to inDegrees.

Definition at line 121 of file cylindricalCS.C.

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

src/meshTools/coordinateSystems/cylindricalCS.H
src/meshTools/coordinateSystems/cylindricalCS.C

Detailed Description

Public Member Functions

Protected Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation