Parabolic cylindrical coordinate system. More...

#include <meshTools/parabolicCylindricalCS.H>

Detailed Description

Parabolic cylindrical coordinate system.

Notation: u = a.x() v = a.y() z = a.z();

Note:: The maintenance of this class may lag that of the main types.

Source files

Definition at line 54 of file parabolicCylindricalCS.H.

Inheritance diagram for parabolicCylindricalCS:

Collaboration diagram for parabolicCylindricalCS:

List of all members.

Public Member Functions
	TypeName ("parabolicCylindrical")
	Runtime type information.
	parabolicCylindricalCS ()
	Construct null.
	parabolicCylindricalCS (const word &name, const point &origin, const coordinateRotation &)
	Construct from origin and rotation.
	parabolicCylindricalCS (const word &, const dictionary &)
	Construct from dictionary.
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

parabolicCylindricalCS ( )

Construct null.

Definition at line 45 of file parabolicCylindricalCS.C.

parabolicCylindricalCS	(	const word &	name,
		const point &	origin,
		const coordinateRotation &	cr
	)

Construct from origin and rotation.

Definition at line 52 of file parabolicCylindricalCS.C.

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

Construct from dictionary.

Definition at line 63 of file parabolicCylindricalCS.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 75 of file parabolicCylindricalCS.C.

References Foam::abort(), Foam::FatalError, FatalErrorIn, coordinateSystem::localToGlobal(), Foam::sqr(), 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 105 of file parabolicCylindricalCS.C.

References Foam::abort(), Field< Type >::component(), Foam::FatalError, FatalErrorIn, coordinateSystem::localToGlobal(), Foam::min(), Field< Type >::replace(), List< T >::size(), Foam::sqr(), 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 148 of file parabolicCylindricalCS.C.

References notImplemented, and Vector< scalar >::zero.

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 162 of file parabolicCylindricalCS.C.

References notImplemented, and Field< vector >::null().

TypeName ( "parabolicCylindrical" )

Runtime type information.

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

src/meshTools/coordinateSystems/parabolicCylindricalCS.H
src/meshTools/coordinateSystems/parabolicCylindricalCS.C

Detailed Description

Public Member Functions

Protected Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation