Provides a centralised coordinateSystem collection. More...

Inheritance diagram for coordinateSystems:

Collaboration diagram for coordinateSystems:

Public Member Functions
	TypeName ("coordinateSystems")
	Runtime type information. More...

	coordinateSystems (const objectRegistry &obr)
	Read construct from objectRegistry. More...

	coordinateSystems (const coordinateSystems &)=delete
	Disallow default bitwise copy construction. More...

virtual	~coordinateSystems ()
	Destructor. More...

virtual bool	global () const
	Is object global. More...

virtual bool	readData (Istream &)
	ReadData function required for regIOobject read operation. More...

bool	writeData (Ostream &) const
	WriteData function required for regIOobject write operation. More...

void	operator= (const coordinateSystems &)=delete
	Disallow default bitwise assignment. More...

Public Member Functions inherited from MeshObject< objectRegistry, GeometricMeshObject, coordinateSystems >
	MeshObject (const objectRegistry &mesh)

	MeshObject (const objectRegistry &mesh, const IOobject &io)

virtual	~MeshObject ()

const objectRegistry &	mesh () const

Public Member Functions inherited from GeometricMeshObject< objectRegistry >
	GeometricMeshObject (const word &typeName, const objectRegistry &obr)

	GeometricMeshObject (const word &typeName, const IOobject &io)

Public Member Functions inherited from TopologicalMeshObject< objectRegistry >
	TopologicalMeshObject (const word &typeName, const objectRegistry &obr)

	TopologicalMeshObject (const word &typeName, const IOobject &io)

Public Member Functions inherited from meshObject
	ClassName ("meshObject")

	meshObject (const word &typeName, const objectRegistry &obr)

	meshObject (const word &typeName, const IOobject &io)

Public Member Functions inherited from regIOobject
	TypeName ("regIOobject")
	Runtime type information. More...

	regIOobject (const IOobject &, const bool isTime=false)
	Construct from IOobject. Optional flag for if IOobject is the. More...

	regIOobject (const regIOobject &)
	Copy constructor. More...

	regIOobject (const regIOobject &&)
	Move constructor. More...

	regIOobject (const regIOobject &, bool registerCopy)
	Copy constructor, transferring registry registration to copy. More...

	regIOobject (const word &newName, const regIOobject &, bool registerCopy)
	Copy constructor with new name, transferring registry registration. More...

	regIOobject (const IOobject &, const regIOobject &)
	Copy constructor with new IO parameters. More...

virtual	~regIOobject ()
	Destructor. More...

virtual bool	globalFile () const
	Return true if object is global, i.e. same for all processors. More...

const fileName &	caseName () const

fileName	path () const
	Return complete path. More...

fileName	objectPath () const
	Return complete path + object name. More...

fileName	filePath () const
	Return complete path + object name if the file exists. More...

bool	checkIn ()
	Add object to registry. More...

bool	checkOut ()
	Remove object from registry. More...

void	addWatch ()
	Add file watch on object (if registered and READ_IF_MODIFIED) More...

bool	registered () const
	Is this object registered with the registry? More...

bool	ownedByRegistry () const
	Is this object owned by the registry? More...

void	store ()
	Transfer ownership of this object to its registry. More...

void	release ()
	Release ownership of this object from its registry. More...

label	eventNo () const
	Event number at last update. More...

label &	eventNo ()
	Event number at last update. More...

bool	upToDate (const regIOobject &) const
	Return true if up-to-date with respect to given object. More...

bool	upToDate (const regIOobject &, const regIOobject &) const
	Return true if up-to-date with respect to given objects. More...

bool	upToDate (const regIOobject &, const regIOobject &, const regIOobject &) const
	Return true if up-to-date with respect to given objects. More...

bool	upToDate (const regIOobject &, const regIOobject &, const regIOobject &, const regIOobject &) const
	Return true if up-to-date with respect to given objects. More...

void	setUpToDate ()
	Set up to date (obviously) More...

virtual void	rename (const word &newName)
	Rename. More...

bool	headerOk ()
	Read and check header info. More...

Istream &	readStream (const word &, const bool read=true)
	Return Istream and check object type against that given. More...

void	close ()
	Close Istream. More...

virtual bool	read ()
	Read object. More...

const labelList &	watchIndices () const
	Return file-monitoring handles. More...

labelList &	watchIndices ()
	Return file-monitoring handles. More...

virtual bool	modified () const
	Return true if the object's file (or files for objectRegistry) More...

virtual bool	readIfModified ()
	Read object if modified (as set by call to modified) More...

virtual bool	writeObject (IOstream::streamFormat, IOstream::versionNumber, IOstream::compressionType, const bool write) const
	Write using given format, version and compression. More...

virtual bool	write (const bool write=true) const
	Write using setting from DB. More...

void	operator= (const IOobject &)

Public Member Functions inherited from IOobject
	TypeName ("IOobject")
	Runtime type information. More...

	IOobject (const word &name, const fileName &instance, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true)
	Construct from name, instance, registry, io options. More...

	IOobject (const word &name, const fileName &instance, const fileName &local, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true)
	Construct from name, instance, local, registry, io options. More...

	IOobject (const fileName &path, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true)
	Construct from path, registry, io options. More...

	IOobject (const IOobject &io, const objectRegistry &registry)
	Construct from copy resetting registry. More...

	IOobject (const IOobject &io, const word &name)
	Construct from copy resetting name. More...

	IOobject (const IOobject &io)=default
	Copy constructor. More...

autoPtr< IOobject >	clone () const
	Clone. More...

autoPtr< IOobject >	clone (const objectRegistry &registry) const
	Clone resetting registry. More...

virtual	~IOobject ()
	Destructor. More...

const Time &	time () const
	Return time. More...

const objectRegistry &	db () const
	Return the local objectRegistry. More...

const word &	name () const
	Return name. More...

const word &	headerClassName () const
	Return name of the class name read from header. More...

word &	headerClassName ()
	Return name of the class name read from header. More...

string &	note ()
	Return non-constant access to the optional note. More...

const string &	note () const
	Return the optional note. More...

bool &	registerObject ()
	Register object created from this IOobject with registry if true. More...

bool	registerObject () const
	Register object created from this IOobject with registry if true. More...

readOption	readOpt () const

readOption &	readOpt ()

writeOption	writeOpt () const

writeOption &	writeOpt ()

word	group () const
	Return group (extension part of name) More...

word	member () const
	Return member (name without the extension) More...

word	modelName (const char *name) const
	Return the name of the object within this model. More...

const fileName &	rootPath () const

const fileName &	caseName (const bool global) const

fileName &	instance () const
	Return the instance directory, constant, system, <time> etc. More...

void	updateInstance () const
	If the instance is a time directory update to the current time. More...

const fileName &	local () const

fileName	path (const bool global) const
	Return complete path including the processor sub-directory. More...

fileName	objectPath (const bool global) const
	Return complete path + object name including the processor. More...

fileName	relativePath () const
	Return the path relative to the case directory. More...

fileName	relativeObjectPath () const
	Return complete relativePath + object name. More...

fileName	filePath (const word &typeName, const bool global) const
	Return complete path + object name if the file exists. More...

bool	readHeader (Istream &)
	Read header. More...

bool	headerOk ()
	Read header of local object without type-checking. More...

template<class Type >
void	warnNoRereading () const
	Helper: warn that type does not support re-reading. More...

bool	writeHeader (Ostream &) const
	Write header. More...

bool	writeHeader (Ostream &, const word &objectType) const
	Write header. Allow override of type. More...

bool	good () const

bool	bad () const

InfoProxy< IOobject >	info () const
	Return info proxy. More...

void	operator= (const IOobject &)

template<class Name >
Foam::word	groupName (Name name, const word &group)

template<class Name >
Foam::word	modelName (Name name, const word &model)

Public Member Functions inherited from PtrDictionary< coordinateSystem >
	PtrDictionary (const label size=128)
	Construct given initial table size. More...

	PtrDictionary (const PtrDictionary &)
	Copy constructor. More...

	PtrDictionary (PtrDictionary &&)
	Move constructor. More...

	PtrDictionary (Istream &, const INew &)
	Construct from Istream using given Istream constructor class. More...

	PtrDictionary (Istream &)
	Construct from Istream. More...

const coordinateSystem &	operator[] (const word &key) const
	Find and return entry. More...

coordinateSystem &	operator[] (const word &key)
	Find and return entry. More...

Public Member Functions inherited from DictionaryBase< DLPtrList< coordinateSystem >, coordinateSystem >
	DictionaryBase (const label size=128)
	Construct given initial table size. More...

	DictionaryBase (const DictionaryBase &)
	Copy constructor. More...

	DictionaryBase (DictionaryBase &&)
	Move constructor. More...

	DictionaryBase (Istream &, const INew &)
	Construct from Istream using given Istream constructor class. More...

	DictionaryBase (Istream &)
	Construct from Istream using default Istream constructor class. More...

bool	found (const word &) const
	Search DictionaryBase for given keyword. More...

const coordinateSystem *	lookupPtr (const word &) const
	Find and return an entry if present, otherwise return nullptr. More...

coordinateSystem *	lookupPtr (const word &)
	Find and return an entry if present, otherwise return nullptr. More...

const coordinateSystem *	lookup (const word &) const
	Find and return entry. More...

coordinateSystem *	lookup (const word &)
	Find and return entry. More...

wordList	toc () const
	Return the table of contents. More...

wordList	sortedToc () const
	Return the table of contents as a sorted list. More...

void	insert (const word &, coordinateSystem *)
	Add at head of dictionary. More...

void	append (const word &, coordinateSystem *)
	Add at tail of dictionary. More...

coordinateSystem *	remove (const word &)
	Remove and return entry specified by keyword. More...

void	clear ()
	Clear the dictionary. More...

void	transfer (DictionaryBase< DLPtrList< coordinateSystem >, coordinateSystem > &)
	Transfer the contents of the argument into this DictionaryBase. More...

void	operator= (const DictionaryBase &)

const coordinateSystem *	operator[] (const word &key) const
	Find and return entry. More...

coordinateSystem *	operator[] (const word &key)
	Find and return entry. More...

Public Member Functions inherited from LPtrList< LListBase, T >
	LPtrList ()
	Null construct. More...

	LPtrList (T *a)
	Construct given initial T. More...

template<class INew >
	LPtrList (Istream &, const INew &)
	Construct from Istream using given Istream constructor class. More...

	LPtrList (Istream &)
	Construct from Istream using default Istream constructor class. More...

	LPtrList (const LPtrList &)
	Copy constructor. More...

	LPtrList (LPtrList &&)
	Move constructor. More...

	~LPtrList ()
	Destructor. More...

T &	first ()
	Return the first entry added. More...

const T &	first () const
	Return const access to the first entry added. More...

T &	last ()
	Return the last entry added. More...

const T &	last () const
	Return const access to the last entry added. More...

bool	eraseHead ()
	Remove the head element from the list and delete the pointer. More...

void	clear ()
	Clear the contents of the list. More...

void	transfer (LPtrList< LListBase, T > &)
	Transfer the contents of the argument into this List. More...

void	operator= (const LPtrList< LListBase, T > &)
	Assignment operator. More...

void	operator= (LPtrList< LListBase, T > &&)
	Move assignment operator. More...

Public Member Functions inherited from LList< LListBase, T *>
	LList ()
	Null construct. More...

	LList (T * a)
	Construct given initial T. More...

	LList (Istream &)
	Construct from Istream. More...

	LList (const LList< LListBase, T * > &)
	Copy constructor. More...

	LList (LList< LListBase, T * > &&)
	Move constructor. More...

	LList (std::initializer_list< T * >)
	Construct from an initialiser list. More...

	~LList ()
	Destructor. More...

T * &	first ()
	Return the first entry added. More...

const T * &	first () const
	Return const access to the first entry added. More...

T * &	last ()
	Return the last entry added. More...

const T * &	last () const
	Return const access to the last entry added. More...

void	insert (const T * &a)
	Add at head of list. More...

void	append (const T * &a)
	Add at tail of list. More...

T *	removeHead ()
	Remove and return head. More...

T *	remove (link *l)
	Remove and return element. More...

T *	remove (iterator &it)
	Remove and return element specified by iterator. More...

void	clear ()
	Delete contents of list. More...

void	transfer (LList< LListBase, T * > &)
	Transfer the contents of the argument into this List. More...

void	operator= (const LList< LListBase, T * > &)
	Assignment operator. More...

void	operator= (LList< LListBase, T * > &&)
	Move assignment operator. More...

void	operator= (std::initializer_list< T * >)
	Assignment to an initialiser list. More...

iterator	begin ()

const_iterator	begin () const

const iterator &	end ()

const const_iterator &	end () const

const_iterator	cbegin () const

const const_iterator &	cend () const

Additional Inherited Members
Public Types inherited from IOobject
enum	objectState { GOOD, BAD }
	Enumeration defining the valid states of an IOobject. More...

enum	readOption { MUST_READ, MUST_READ_IF_MODIFIED, READ_IF_PRESENT, NO_READ }
	Enumeration defining the read options. More...

enum	writeOption { AUTO_WRITE = 0, NO_WRITE = 1 }
	Enumeration defining the write options. More...

enum	fileCheckTypes { timeStamp, timeStampMaster, inotify, inotifyMaster }
	Enumeration defining the file checking options. More...

Public Types inherited from LPtrList< LListBase, T >
typedef T &	reference
	Type that can be used for storing into LPtrList::value_type. More...

typedef T &	const_reference
	Type that can be used for storing into constant. More...

typedef LListBase::iterator	LListBase_iterator

typedef LListBase::const_iterator	LListBase_const_iterator

Public Types inherited from LList< LListBase, T *>
typedef T *	value_type
	Type of values the LList contains. More...

typedef T * &	reference
	Type that can be used for storing into value_type. More...

typedef const T * &	const_reference
	Type that can be used for storing into constant. More...

typedef label	size_type
	The type that can represent the size of a LList. More...

typedef LListBase::iterator	LListBase_iterator

typedef LListBase::const_iterator	LListBase_const_iterator

Static Public Member Functions inherited from MeshObject< objectRegistry, GeometricMeshObject, coordinateSystems >
static coordinateSystems &	New (objectRegistry &mesh)

static const coordinateSystems &	New (const objectRegistry &mesh)

static coordinateSystems &	New (objectRegistry &mesh, const Args &... args)

static const coordinateSystems &	New (const objectRegistry &mesh, const Args &... args)

static bool	Delete (const objectRegistry &mesh)

static bool	found (const objectRegistry &mesh)
	Return true if this MeshObject is found in the mesh registry. More...

Static Public Member Functions inherited from meshObject
template<class Mesh >
static void	movePoints (objectRegistry &)

template<class Mesh >
static void	topoChange (objectRegistry &, const polyTopoChangeMap &)

template<class Mesh >
static void	mapMesh (objectRegistry &, const polyMeshMap &)

template<class Mesh >
static void	distribute (objectRegistry &, const polyDistributionMap &)

template<class Mesh >
static void	addPatch (objectRegistry &, const label patchi)

template<class Mesh >
static void	reorderPatches (objectRegistry &, const labelUList &newToOld, const bool validBoundary)

template<class Mesh , template< class > class MeshObjectType>
static void	clear (objectRegistry &)

template<class Mesh , template< class > class FromType, template< class > class ToType>
static void	clearUpto (objectRegistry &)
	Clear all meshObject derived from FromType up to (but not including) More...

Static Public Member Functions inherited from regIOobject
template<class Type >
static Type &	store (Type *)
	Transfer ownership of the given object pointer to its registry. More...

template<class Type >
static Type &	store (autoPtr< Type > &)
	Transfer ownership of the given object pointer to its registry. More...

Static Public Member Functions inherited from IOobject
static bool	fileNameComponents (const fileName &path, fileName &instance, fileName &local, word &name)
	Split path into instance, local, name components. More...

template<class Name >
static word	groupName (Name name, const word &group)

static word	group (const word &name)
	Return group (extension part of name) More...

static word	member (const word &name)
	Return member (name without the extension) More...

template<class Name >
static word	modelName (Name name, const word &model)
	Return the name of the object within the given model. More...

template<class Stream >
static Stream &	writeBanner (Stream &os, bool noHint=false)
	Write the standard OpenFOAM file/dictionary banner. More...

template<class Stream >
static Stream &	writeDivider (Stream &os)
	Write the standard file section divider. More...

template<class Stream >
static Stream &	writeEndDivider (Stream &os)
	Write the standard end file divider. More...

Static Public Attributes inherited from regIOobject
static float	fileModificationSkew

Static Public Attributes inherited from IOobject
static constexpr const char *	foamFile = "FoamFile"
	Keyword for the FoamFile header sub-dictionary. More...

static const NamedEnum< fileCheckTypes, 4 >	fileCheckTypesNames

static fileCheckTypes	fileModificationChecking
	Type of file modification checking. More...

Protected Member Functions inherited from regIOobject
bool	readHeaderOk (const IOstream::streamFormat defaultFormat, const word &typeName)
	Read header, check readOpt flags and read data if necessary. More...

Protected Member Functions inherited from IOobject
void	setBad (const string &)
	Set the object state to bad. More...

template<class Type >
bool	typeHeaderOk (const bool checkType)
	Read header using typeGlobalFile to find file. More...

Protected Member Functions inherited from DictionaryBase< DLPtrList< coordinateSystem >, coordinateSystem >
void	addEntries ()

Protected Attributes inherited from MeshObject< objectRegistry, GeometricMeshObject, coordinateSystems >
const objectRegistry &	mesh_

Protected Attributes inherited from DictionaryBase< DLPtrList< coordinateSystem >, coordinateSystem >
HashTable< coordinateSystem *>	hashedTs_
	HashTable of the entries held on the IDLListType for quick lookup. More...

Detailed Description

Provides a centralised coordinateSystem collection.

For example with the porous region specified in constant/fvModels as

porosity
{
    type            explicitPorositySource;

    explicitPorositySourceCoeffs
    {
        selectionMode   cellZone;
        cellZone        porousBlockage;

        type            DarcyForchheimer;

        // D 100;  // Very little blockage
        // D 200;  // Some blockage but steady flow
        // D 500;  // Slight waviness in the far wake
        D 1000; // Fully shedding behavior

        d   ($D $D $D);
        f   (0 0 0);

        coordinateSystem porousBlockage;
    }
}

the corresponding coordinate system porousBlockage is looked-up automatically from the constant/coordinateSystems dictionary:

porousBlockage
{
    type    cartesian;
    origin  (0 0 0);
    coordinateRotation
    {
        type    axesRotation;
        e1  (1 0 0);
        e2  (0 1 0);
    }
}

See tutorials/incompressible/pisoFoam/laminar/porousBlockage

Source files

Definition at line 97 of file coordinateSystems.H.