toroidalCS Class Reference

Toroidal coordinate system, always in degrees. More...

Inheritance diagram for toroidalCS:

[legend]

Collaboration diagram for toroidalCS:

[legend]

List of all members.

Public Member Functions
	TypeName ("toroidal")
	Runtime type information.
	toroidalCS (const word &name, const point &origin, const coordinateRotation &, const scalar radius)
	Construct from origin, rotation and radius.
	toroidalCS (const word &name, const dictionary &)
	Construct from dictionary.
scalar	radius () const
	Return radius.
virtual void	write (Ostream &) const
	Write.
virtual void	writeDict (Ostream &, bool subDict=true) const
	Write dictionary.

---

Detailed Description

Toroidal coordinate system, always in degrees.

Note:

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

Source files

• toroidalCS.H
• toroidalCS.C

Definition at line 48 of file toroidalCS.H.

---

Constructor & Destructor Documentation

toroidalCS	(	const word &	name,
		const point &	origin,
		const coordinateRotation &	cr,
		const scalar	radius
	)

Construct from origin, rotation and radius.

Definition at line 34 of file toroidalCS.C.

References Foam::addToRunTimeSelectionTable(), and Foam::defineTypeNameAndDebug().

Here is the call graph for this function:

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

Construct from dictionary.

Definition at line 47 of file toroidalCS.C.

---

Member Function Documentation

TypeName

(

"toroidal"

)

Runtime type information.

scalar radius

(

)

const [inline]

Return radius.

Definition at line 116 of file toroidalCS.H.

Referenced by toroidalCS::writeDict().

Here is the caller graph for this function:

void write

(

Ostream &

os

)

const [virtual]

Write.

Reimplemented from coordinateSystem.

Definition at line 141 of file toroidalCS.C.

Referenced by toroidalCS::writeDict().

Here is the caller graph for this function:

void writeDict	(	Ostream &	os,
		bool	subDict = true
	)			const [virtual]

Write dictionary.

Reimplemented from coordinateSystem.

Definition at line 148 of file toroidalCS.C.

References Foam::endl(), toroidalCS::radius(), and toroidalCS::write().

Here is the call graph for this function:

---

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

• src/meshTools/coordinateSystems/toroidalCS.H
• src/meshTools/coordinateSystems/toroidalCS.C