A centralized collection of named coordinate systems. More...

Inheritance diagram for coordinateSystems:

Collaboration diagram for coordinateSystems:

Public Member Functions
	TypeNameNoDebug ("coordinateSystems")

	coordinateSystems (const IOobject &io)

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

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

labelList	indices (const wordRe &key) const

labelList	indices (const wordRes &matcher) const

label	findIndex (const wordRe &key) const

label	findIndex (const wordRes &matcher) const

bool	found (const wordRe &key) const

const coordinateSystem *	cfind (const word &name) const

const coordinateSystem &	lookup (const word &name) const

wordList	names () const

wordList	names (const wordRe &key) const

wordList	names (const wordRes &matcher) const

wordList	toc () const

bool	writeData (Ostream &os) const

virtual bool	writeObject (IOstreamOption streamOpt, const bool valid=true) const

labelList	findIndices (const wordRe &key) const

const coordinateSystem *	lookupPtr (const word &name) const

Public Member Functions inherited from regIOobject
	TypeName ("regIOobject")

	regIOobject (const IOobject &io, const bool isTimeObject=false)

	regIOobject (const regIOobject &rio)

	regIOobject (const regIOobject &rio, bool registerCopy)

	regIOobject (const word &newName, const regIOobject &, bool registerCopy)

	regIOobject (const IOobject &io, const regIOobject &rio)

virtual	~regIOobject ()

bool	checkIn ()

bool	checkOut ()

virtual void	addWatch ()

bool	ownedByRegistry () const

bool	store ()

void	release (const bool unregister=false)

label	eventNo () const

label &	eventNo ()

bool	upToDate (const regIOobject &) const

bool	upToDate (const regIOobject &, const regIOobject &) const

bool	upToDate (const regIOobject &, const regIOobject &, const regIOobject &) const

bool	upToDate (const regIOobject &, const regIOobject &, const regIOobject &, const regIOobject &) const

void	setUpToDate ()

virtual void	rename (const word &newName)

const dictionary *	findMetaData () const noexcept

dictionary &	getMetaData () noexcept

void	removeMetaData ()

virtual void	updateMetaData ()

virtual fileName	filePath () const

bool	headerOk ()

Istream &	readStream (const word &, const bool valid=true)

void	close ()

virtual bool	readData (Istream &)

virtual bool	read ()

virtual label	addWatch (const fileName &)

const labelList &	watchIndices () const

labelList &	watchIndices ()

virtual bool	modified () const

virtual bool	readIfModified ()

virtual bool	write (const bool valid=true) const

virtual bool	global () const

void	operator= (const IOobject &io)

virtual bool	writeObject (IOstreamOption::streamFormat fmt, IOstreamOption::versionNumber ver, IOstreamOption::compressionType comp, const bool valid) const

Public Member Functions inherited from IOobject
	TypeName ("IOobject")

	IOobject (const IOobject &)=default

virtual	~IOobject ()=default

	IOobject (const word &name, const fileName &instance, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true, bool globalObject=false)

	IOobject (const word &name, const fileName &instance, const fileName &local, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true, bool globalObject=false)

	IOobject (const fileName &path, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true, bool globalObject=false)

	IOobject (const IOobject &io, const objectRegistry &registry)

	IOobject (const IOobject &io, const word &name)

	IOobject (const IOobject &io, readOption, writeOption)

autoPtr< IOobject >	clone () const

autoPtr< IOobject >	clone (const objectRegistry &registry) const

const objectRegistry &	db () const noexcept

const Time &	time () const

const word &	name () const noexcept

const word &	headerClassName () const noexcept

word &	headerClassName () noexcept

const string &	note () const noexcept

string &	note () noexcept

bool	registerObject () const noexcept

bool	registerObject (bool on) noexcept

bool	globalObject () const noexcept

bool	globalObject (bool on) noexcept

unsigned	labelByteSize () const noexcept

unsigned	scalarByteSize () const noexcept

bool	isHeaderClassName (const word &clsName) const

template<class Type >
bool	isHeaderClassName () const

readOption	readOpt () const noexcept

readOption	readOpt (readOption opt) noexcept

writeOption	writeOpt () const noexcept

writeOption	writeOpt (writeOption opt) noexcept

word	group () const

word	member () const

const fileName &	rootPath () const

const fileName &	caseName () const

const fileName &	instance () const noexcept

fileName &	instance () noexcept

const fileName &	local () const noexcept

fileName	path () const

fileName	path (const word &instance, const fileName &local=fileName::null) const

fileName	objectPath () const

fileName	objectRelPath () const

fileName	localFilePath (const word &typeName, const bool search=true) const

fileName	globalFilePath (const word &typeName, const bool search=true) const

IOstreamOption	parseHeader (const dictionary &headerDict)

bool	readHeader (Istream &is)

bool	readHeader (dictionary &headerDict, Istream &is)

template<class Type >
bool	typeHeaderOk (const bool checkType=true, const bool search=true, const bool verbose=true)

template<class Type >
void	warnNoRereading () const

bool	writeHeader (Ostream &os) const

bool	writeHeader (Ostream &os, const word &objectType) const

void	writeHeader (dictionary &dict, IOstreamOption streamOpt) const

void	writeHeader (dictionary &dict, const word &objectType, IOstreamOption streamOpt) const

bool	good () const noexcept

bool	bad () const noexcept

InfoProxy< IOobject >	info () const

void	operator= (const IOobject &io)

readOption &	readOpt () noexcept

writeOption &	writeOpt () noexcept

bool &	registerObject () noexcept

bool &	globalObject () noexcept

template<>
bool	isHeaderClassName () const

template<class StringType >
Foam::word	groupName (StringType base, const word &group)

Public Member Functions inherited from PtrList< coordinateSystem >
constexpr	PtrList () noexcept

	PtrList (const label len)

	PtrList (const PtrList< T > &list)

	PtrList (PtrList< T > &&list)

	PtrList (UList< T * > &list)

	PtrList (const PtrList< T > &list, const CloneArg &cloneArgs)

	PtrList (PtrList< T > &list, bool reuse)

	PtrList (const SLPtrList< T > &list)

	PtrList (Istream &is, const INew &inew)

	PtrList (Istream &is)

	PtrList (PtrList< T > &list, bool reuse)

	PtrList (const SLPtrList< T > &list)

constexpr	PtrList () noexcept

	PtrList (const label len)

	PtrList (const PtrList< T > &list)

	PtrList (PtrList< T > &&list)

	PtrList (UList< T * > &list)

	PtrList (Istream &is)

	~PtrList ()

PtrList< T >	clone (Args &&... args) const

Foam::PtrList< T >	clone (Args &&... args) const

const T *	set (const label i) const

autoPtr< T >	set (const label i, T *ptr)

autoPtr< T >	set (const label i, autoPtr< T > &ptr)

autoPtr< T >	set (const label i, autoPtr< T > &&ptr)

autoPtr< T >	set (const label i, std::unique_ptr< T > &&ptr)

autoPtr< T >	set (const label i, const refPtr< T > &ptr)

autoPtr< T >	set (const label i, const tmp< T > &ptr)

void	clear ()

void	resize (const label newLen)

void	setSize (const label newLen)

void	emplace_append (Args &&... args)

void	append (T *ptr)

void	append (autoPtr< T > &ptr)

void	append (autoPtr< T > &&ptr)

void	append (std::unique_ptr< T > &&ptr)

void	append (const refPtr< T > &ptr)

void	append (const tmp< T > &ptr)

autoPtr< T >	emplace (const label i, Args &&... args)

Foam::autoPtr< T >	emplace (const label i, Args &&... args)

autoPtr< T >	release (const label i)

void	transfer (PtrList< T > &list)

void	operator= (const PtrList< T > &list)

void	operator= (PtrList< T > &&list)

Static Public Member Functions
static const coordinateSystems &	New (const objectRegistry &obr)

Static Public Member Functions inherited from regIOobject
template<class Type >
static Type &	store (Type *p)

template<class Type >
static Type &	store (autoPtr< Type > &ptr)

template<class Type >
static Type &	store (autoPtr< Type > &&ptr)

template<class Type >
static Type &	store (refPtr< Type > &ptr)

template<class Type >
static Type &	store (refPtr< Type > &&ptr)

template<class Type >
static Type &	store (tmp< Type > &ptr)

template<class Type >
static Type &	store (tmp< Type > &&ptr)

Static Public Member Functions inherited from IOobject
static bool	bannerEnabled () noexcept

static bool	bannerEnabled (bool on) noexcept

static bool	fileNameComponents (const fileName &path, fileName &instance, fileName &local, word &name)

template<class StringType >
static word	groupName (StringType base, const word &group)

static word	group (const word &name)

static word	member (const word &name)

static word	scopedName (const std::string &scope, const word &name)

static IOobject	selectIO (const IOobject &io, const fileName &altFile, const word &ioName="")

static Ostream &	writeBanner (Ostream &os, const bool noSyntaxHint=false)

static Ostream &	writeDivider (Ostream &os)

static Ostream &	writeEndDivider (Ostream &os)

Additional Inherited Members
Public Types inherited from IOobject
enum	objectState : char { GOOD, BAD }

enum	readOption : char { MUST_READ, MUST_READ_IF_MODIFIED, READ_IF_PRESENT, NO_READ }

enum	writeOption : char { AUTO_WRITE = 0, NO_WRITE = 1 }

enum	fileCheckTypes : char { timeStamp, timeStampMaster, inotify, inotifyMaster }

Static Public Attributes inherited from IOobject
static const Enum< fileCheckTypes >	fileCheckTypesNames

static char	scopeSeparator

static fileCheckTypes	fileModificationChecking

static float	fileModificationSkew

static int	maxFileModificationPolls

Protected Member Functions inherited from regIOobject
bool	readHeaderOk (const IOstreamOption::streamFormat fmt, const word &typeName)

Protected Member Functions inherited from IOobject
void	setBad (const string &s)

Protected Member Functions inherited from PtrList< coordinateSystem >
void	readIstream (Istream &is, const INew &inew)

void	free ()

Static Protected Member Functions inherited from IOobject
static void	writeHeaderContent (Ostream &os, const IOobject &io, const word &objectType, const dictionary *metaDataDict=nullptr)

static void	writeHeaderContent (dictionary &dict, const IOobject &io, const word &objectType, IOstreamOption streamOpt, const dictionary *metaDataDict=nullptr)

Static Protected Attributes inherited from regIOobject
static bool	masterOnlyReading = false

Detailed Description

A centralized collection of named coordinate systems.

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

cat1
{
    coordinateSystem
    {
        type   indirect;
        name   _10;
    }
    porosity    0.781;
    Darcy
    {
        d   d [0 -2 0 0 0]  (-1000 -1000 0.50753e+08);
        f   f [0 -1 0 0 0]  (-1000 -1000 12.83);
    }
}

For this to work correctly, the coordinateSystem constructor must be supplied with an objectRegistry as well as the dictionary.

Source files

Definition at line 74 of file coordinateSystems.H.