coordinateSystems Class Reference

Provides a centralized coordinateSystem collection. More...

#include <meshTools/coordinateSystems.H>

---

Detailed Description

Provides a centralized coordinateSystem collection.

Note:

Mixing normal constructors and the coordinateSystems::New constructor may yield unexpected results.

Source files

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

Definition at line 53 of file coordinateSystems.H.

Inheritance diagram for coordinateSystems:

Collaboration diagram for coordinateSystems:

List of all members.

Public Member Functions
	TypeName ("coordinateSystems")
	Runtime type information.
	coordinateSystems (const IOobject &)
	Read construct from IOobject.
	coordinateSystems (const IOobject &, const PtrList< coordinateSystem > &)
	Construct from IOobject and a PtrList.
	coordinateSystems (const IOobject &, const Xfer< PtrList< coordinateSystem > > &)
	Construct from IOobject and transferring the PtrList contents.
label	find (const word &key) const
	Find and return index for a given keyword, returns -1 if not found.
bool	found (const word &keyword) const
	Search for given keyword.
wordList	toc () const
	Return the table of contents (list of all keywords)
bool	writeData (Ostream &, bool subDict=true) const
	write data
Static Public Member Functions
static const coordinateSystems &	New (const objectRegistry &)
	Return previously registered or read construct from "constant".

---

Constructor & Destructor Documentation

coordinateSystems

(

const IOobject &

io  )

[explicit]

Read construct from IOobject.

Definition at line 40 of file coordinateSystems.C.

coordinateSystems	(	const IOobject &	io,
		const PtrList< coordinateSystem > &	lst
	)

Construct from IOobject and a PtrList.

Definition at line 47 of file coordinateSystems.C.

coordinateSystems	(	const IOobject &	io,
		const Xfer< PtrList< coordinateSystem > > &	lst
	)

Construct from IOobject and transferring the PtrList contents.

Definition at line 57 of file coordinateSystems.C.

---

Member Function Documentation

TypeName

(

"coordinateSystems"

)

Runtime type information.

const Foam::coordinateSystems & New

(

const objectRegistry &

obr  )

[static]

Return previously registered or read construct from "constant".

Definition at line 70 of file coordinateSystems.C.

References objectRegistry::foundObject(), objectRegistry::lookupObject(), IOobject::NO_WRITE, IOobject::READ_IF_PRESENT, and regIOobject::store().

Referenced by coordinateSystem::coordinateSystem().

Foam::label find

(

const word &

key  )

const

Find and return index for a given keyword, returns -1 if not found.

Definition at line 100 of file coordinateSystems.C.

References forAll, and Foam::name().

Referenced by coordinateSystem::coordinateSystem().

bool found

(

const word &

keyword  )

const

Search for given keyword.

Definition at line 114 of file coordinateSystems.C.

Foam::wordList toc

(

)

const

Return the table of contents (list of all keywords)

Definition at line 120 of file coordinateSystems.C.

References forAll.

Referenced by coordinateSystem::coordinateSystem().

bool writeData	(	Ostream &	os,
		bool	subDict = true
	)		const

write data

Definition at line 133 of file coordinateSystems.C.

References token::BEGIN_LIST, token::END_LIST, forAll, IOstream::good(), and Foam::nl.

---

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

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