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

Inheritance diagram for coordinateSystems:

Collaboration diagram for coordinateSystems:

Public Member Functions
	TypeNameNoDebug ("coordinateSystems")
	Declare type-name, virtual type (without debug switch) More...

	coordinateSystems (const IOobject &io)
	Read construct from IOobject. More...

	coordinateSystems (const IOobject &io, const PtrList< coordinateSystem > &content)
	Construct from IOobject and PtrList content. More...

	coordinateSystems (const IOobject &io, PtrList< coordinateSystem > &&content)
	Construct from IOobject and transferring PtrList content. More...

labelList	indices (const keyType &key) const
	Find and return indices for all matches. More...

labelList	indices (const wordRes &matcher) const
	Find and return indices for all matches. More...

label	findIndex (const keyType &key) const
	Find and return index for the first match, return -1 if not found. More...

label	findIndex (const wordRes &matcher) const
	Find and return index for the first match, return -1 if not found. More...

bool	found (const keyType &key) const
	Search if given key exists. More...

const coordinateSystem *	cfind (const word &name) const
	Return pointer to named coordinateSystem or nullptr on error. More...

const coordinateSystem &	lookup (const word &name) const
	Return reference to named coordinateSystem or FatalErrror. More...

wordList	names () const
	A list of the coordinate-system names. More...

wordList	names (const keyType &key) const
	A list of the coordinate-system names satisfying the input matcher. More...

wordList	names (const wordRe &matcher) const
	A list of the coordinate-system names satisfying the input matcher. More...

wordList	names (const wordRes &matcher) const
	A list of the coordinate-system names satisfying the input matcher. More...

wordList	toc () const
	Identical to names() More...

bool	writeData (Ostream &os) const
	Write data. More...

virtual bool	writeObject (IOstreamOption streamOpt, const bool valid=true) const
	Write using stream options. More...

labelList	findIndices (const keyType &key) const
	Identical to the indices() method (AUG-2018) More...

const coordinateSystem *	lookupPtr (const word &name) const
	Deprecated(2020-03) find named coordinateSystem or nullptr. More...

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

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

	regIOobject (const regIOobject &rio)
	Copy construct. More...

	regIOobject (const regIOobject &rio, bool registerCopy)

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

	regIOobject (const IOobject &io, const regIOobject &rio)
	Copy construct with new IO parameters. More...

virtual	~regIOobject ()
	Destructor. More...

bool	checkIn ()
	Add object to registry, if not already registered. More...

bool	checkOut ()
	Remove all file watches and remove object from registry. More...

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

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

bool	store ()

void	release (const bool unregister=false)
	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 as up-to-date. More...

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

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

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

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

void	close ()
	Close Istream. More...

virtual bool	readData (Istream &)
	Virtual readData function. More...

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

virtual label	addWatch (const fileName &)
	Add file watch for fileName on object if not yet watched. More...

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

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

virtual bool	modified () const

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

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

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

void	operator= (const IOobject &io)
	Copy assignment. More...

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

Public Member Functions inherited from IOobject
	TypeName ("IOobject")
	Declare type-name, virtual type (with debug switch) More...

	IOobject (const IOobject &)=default
	Copy construct. More...

virtual	~IOobject ()=default
	Destructor. 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, bool globalObject=false)
	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, bool globalObject=false)
	Construct from path, registry, io options. More...

	IOobject (const IOobject &io, const objectRegistry &registry)
	Copy construct, resetting registry. More...

	IOobject (const IOobject &io, const word &name)
	Copy construct, resetting name. More...

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

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

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

const Time &	time () const
	Return time. 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 non-constant access to the class name read from header. More...

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

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

bool	registerObject () const
	Should object created with this IOobject be registered? More...

bool &	registerObject ()
	Should object created with this IOobject be registered? More...

bool	globalObject () const
	Is object same for all processors? More...

bool &	globalObject ()
	Is object same for all processors? More...

unsigned	labelByteSize () const
	The label byte-size, possibly read from the header. More...

unsigned	scalarByteSize () const
	The scalar byte-size, possibly read from the header. More...

bool	isHeaderClassName (const word &clsName) const
	Test if headerClassName() equals the given class name. More...

template<class Type >
bool	isHeaderClassName () const
	Test if headerClassName() equals Type::typeName. More...

readOption	readOpt () const
	The read option. More...

readOption &	readOpt ()
	Non-constant access to the read option. More...

writeOption	writeOpt () const
	The write option. More...

writeOption &	writeOpt ()
	Non-constant access to the write option. More...

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

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

const fileName &	rootPath () const

const fileName &	caseName () const

const fileName &	instance () const

fileName &	instance ()

const fileName &	local () const

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

fileName	path (const word &instance, const fileName &local=fileName::null) const
	The complete path with alternative instance and local. More...

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

fileName	localFilePath (const word &typeName, const bool search=true) const
	Helper for filePath that searches locally. More...

fileName	globalFilePath (const word &typeName, const bool search=true) const
	Helper for filePath that searches up if in parallel. More...

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

template<class Type >
bool	typeHeaderOk (const bool checkType=true, const bool search=true, const bool verbose=true)
	Read header (uses typeFilePath to find file) and check its info. More...

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

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

bool	writeHeader (Ostream &os, 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 &io)

template<>
bool	isHeaderClassName () const
	Specialization for `void` always returns true (no headerClassName check). More...

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

template<class StringType >
Foam::word	scopedName (StringType scope, const word &name)

Public Member Functions inherited from PtrList< coordinateSystem >
constexpr	PtrList () noexcept
	Construct null. More...

	PtrList (const label len)
	Construct with specified size, each element initialized to nullptr. More...

	PtrList (const PtrList< coordinateSystem > &list)
	Copy construct using 'clone()' method on each element. More...

	PtrList (PtrList< coordinateSystem > &&list)
	Move construct. More...

	PtrList (UList< coordinateSystem * > &list)
	Take ownerskip of pointers in the list, set old pointers to null. More...

	PtrList (const PtrList< coordinateSystem > &list, const CloneArg &cloneArgs)
	Copy construct using 'clone()' method on each element. More...

	PtrList (PtrList< coordinateSystem > &list, bool reuse)
	Construct as copy or re-use as specified. More...

	PtrList (const SLPtrList< coordinateSystem > &list)
	Copy construct using 'clone()' on each element of SLPtrList<T> More...

	PtrList (Istream &is, const INew &inew)
	Construct from Istream using given Istream constructor class. More...

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

	~PtrList ()
	Destructor. More...

PtrList< coordinateSystem >	clone (Args &&... args) const
	Make a copy by cloning each of the list elements. More...

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

void	clear ()
	Clear the PtrList. Delete allocated entries and set size to zero. More...

void	resize (const label newLen)
	Adjust size of PtrList. More...

void	setSize (const label newLen)
	Same as resize() More...

void	append (coordinateSystem *ptr)
	Append an element to the end of the list. More...

void	append (autoPtr< coordinateSystem > &aptr)
	Move append an element to the end of the list. More...

void	append (autoPtr< coordinateSystem > &&aptr)
	Move append an element to the end of the list. More...

void	append (const tmp< coordinateSystem > &tptr)
	Move or clone append a tmp to the end of the list. More...

void	transfer (PtrList< coordinateSystem > &list)
	Transfer into this list and annul the argument list. More...

const coordinateSystem *	set (const label i) const
	Return const pointer to element (if set) or nullptr. More...

autoPtr< coordinateSystem >	set (const label i, coordinateSystem *ptr)
	Set element to given pointer and return old element (can be null) More...

autoPtr< coordinateSystem >	set (const label i, autoPtr< coordinateSystem > &aptr)
	Set element to given autoPtr and return old element. More...

autoPtr< coordinateSystem >	set (const label i, autoPtr< coordinateSystem > &&aptr)
	Set element to given autoPtr and return old element. More...

autoPtr< coordinateSystem >	set (const label i, const tmp< coordinateSystem > &tptr)
	Set element to given tmp and return old element. More...

autoPtr< coordinateSystem >	release (const label i)
	Release ownership of the pointer at the given position. More...

void	operator= (const PtrList< coordinateSystem > &list)
	Copy assignment. More...

void	operator= (PtrList< coordinateSystem > &&list)
	Move assignment. More...

Static Public Member Functions
static const coordinateSystems &	New (const objectRegistry &obr)
	Return previously registered or read construct from "constant". More...

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

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

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

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

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

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 StringType >
static word	groupName (StringType base, const word &group)
	Create dot-delimited name.group string. More...

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 StringType >
static word	scopedName (StringType scope, const word &name)
	Create scope:name or scope_name string. More...

static IOobject	selectIO (const IOobject &io, const fileName &altFile, const word &ioName="")
	Return the IOobject, but also consider an alternative file name. More...

static Ostream &	writeBanner (Ostream &os, bool noHint=false)
	Write the standard OpenFOAM file/dictionary banner. More...

static Ostream &	writeDivider (Ostream &os)
	Write the standard file section divider. More...

static Ostream &	writeEndDivider (Ostream &os)
	Write the standard end file divider. More...

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

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

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

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

Static Public Attributes inherited from regIOobject
static float	fileModificationSkew

static int	maxFileModificationPolls

Static Public Attributes inherited from IOobject
static const Enum< fileCheckTypes >	fileCheckTypesNames
	Names for the fileCheckTypes. More...

static char	scopeSeparator
	Character for scoping object names (':' or '_') More...

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

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

Istream *	objectStream ()
	Construct and return an IFstream for the object. More...

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

Protected Member Functions inherited from PtrList< coordinateSystem >
void	readIstream (Istream &is, const INew &inew)
	Read from Istream using Istream constructor class. More...

void	free ()
	Delete the allocated entries, but retain the list size. More...

Static Protected Attributes inherited from regIOobject
static bool	masterOnlyReading = false
	To flag master-only reading of objects. More...

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 77 of file coordinateSystems.H.

Constructor & Destructor Documentation

◆ coordinateSystems() [1/3]

coordinateSystems ( const IOobject & io )

explicit

Read construct from IOobject.

Definition at line 197 of file coordinateSystems.C.

◆ coordinateSystems() [2/3]

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

Construct from IOobject and PtrList content.

Definition at line 207 of file coordinateSystems.C.

◆ coordinateSystems() [3/3]

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

Construct from IOobject and transferring PtrList content.

Definition at line 223 of file coordinateSystems.C.

Member Function Documentation

◆ TypeNameNoDebug()

TypeNameNoDebug ( "coordinateSystems" )

Declare type-name, virtual type (without debug switch)

◆ New()

const Foam::coordinateSystems & New ( const objectRegistry & obr )

static

Return previously registered or read construct from "constant".

Definition at line 238 of file coordinateSystems.C.

References TimePaths::constant(), objectRegistry::findObject(), IOobject::NO_WRITE, IOobject::READ_IF_PRESENT, regIOobject::store(), and objectRegistry::time().

Here is the call graph for this function:

◆ indices() [1/2]

Foam::labelList indices ( const keyType & key ) const

Find and return indices for all matches.

Definition at line 271 of file coordinateSystems.C.

References Foam::indicesImpl(), and keyType::isPattern().

Referenced by coordinateSystems::findIndices().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ indices() [2/2]

Foam::labelList indices ( const wordRes & matcher ) const

Find and return indices for all matches.

Definition at line 292 of file coordinateSystems.C.

References Foam::indicesImpl().

Here is the call graph for this function:

◆ findIndex() [1/2]

Foam::label findIndex ( const keyType & key ) const

Find and return index for the first match, return -1 if not found.

Definition at line 298 of file coordinateSystems.C.

References Foam::findIndexImpl(), and keyType::isPattern().

Here is the call graph for this function:

◆ findIndex() [2/2]

Foam::label findIndex ( const wordRes & matcher ) const

Find and return index for the first match, return -1 if not found.

Definition at line 320 of file coordinateSystems.C.

References Foam::findIndexImpl().

Here is the call graph for this function:

◆ found()

bool found ( const keyType & key ) const

Search if given key exists.

Definition at line 326 of file coordinateSystems.C.

References Foam::findIndex().

Here is the call graph for this function:

◆ cfind()

const Foam::coordinateSystem * cfind ( const word & name ) const

Return pointer to named coordinateSystem or nullptr on error.

Definition at line 333 of file coordinateSystems.C.

References Foam::expressions::patchExpr::debug, Foam::endl(), Foam::findIndex(), InfoInFunction, and Foam::name().

Referenced by coordinateSystems::lookupPtr().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ lookup()

const Foam::coordinateSystem & lookup ( const word & name ) const

Return reference to named coordinateSystem or FatalErrror.

Definition at line 354 of file coordinateSystems.C.

References Foam::expressions::patchExpr::debug, Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, Foam::findIndex(), Foam::flatOutput(), InfoInFunction, Foam::name(), and Foam::nl.

Here is the call graph for this function:

◆ names() [1/4]

Foam::wordList names ( ) const

A list of the coordinate-system names.

Definition at line 377 of file coordinateSystems.C.

References forAll.

Referenced by coordinateSystems::toc().

Here is the caller graph for this function:

◆ names() [2/4]

Foam::wordList names ( const keyType & key ) const

A list of the coordinate-system names satisfying the input matcher.

Definition at line 393 of file coordinateSystems.C.

References keyType::isPattern(), and Foam::namesImpl().

Here is the call graph for this function:

◆ names() [3/4]

Foam::wordList names ( const wordRe & matcher ) const

A list of the coordinate-system names satisfying the input matcher.

Definition at line 414 of file coordinateSystems.C.

References Foam::namesImpl().

Here is the call graph for this function:

◆ names() [4/4]

Foam::wordList names ( const wordRes & matcher ) const

A list of the coordinate-system names satisfying the input matcher.

Definition at line 420 of file coordinateSystems.C.

References Foam::namesImpl().

Here is the call graph for this function:

◆ toc()

wordList toc ( ) const

inline

Identical to names()

Definition at line 167 of file coordinateSystems.H.

References coordinateSystems::names().

Here is the call graph for this function:

◆ writeData()

bool writeData ( Ostream & os ) const

virtual

Write data.

Implements regIOobject.

Definition at line 426 of file coordinateSystems.C.

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

Here is the call graph for this function:

◆ writeObject()

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

virtual

Write using stream options.

Reimplemented from regIOobject.

Definition at line 445 of file coordinateSystems.C.

References IOstreamOption::ASCII, and regIOobject::writeObject().

Here is the call graph for this function:

◆ findIndices()

labelList findIndices ( const keyType & key ) const

inline

Identical to the indices() method (AUG-2018)

Definition at line 189 of file coordinateSystems.H.

References coordinateSystems::indices().

Here is the call graph for this function:

◆ lookupPtr()

const coordinateSystem* lookupPtr ( const word & name ) const

inline

Deprecated(2020-03) find named coordinateSystem or nullptr.

Deprecated:: (2020-03) - use cfind() method

Definition at line 198 of file coordinateSystems.H.

References coordinateSystems::cfind().

Here is the call graph for this function:

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

src/meshTools/coordinate/systems/coordinateSystems.H
src/meshTools/coordinate/systems/coordinateSystems.C

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ coordinateSystems() [1/3]

◆ coordinateSystems() [2/3]

◆ coordinateSystems() [3/3]

Member Function Documentation

◆ TypeNameNoDebug()

◆ New()

◆ indices() [1/2]

◆ indices() [2/2]

◆ findIndex() [1/2]

◆ findIndex() [2/2]

◆ found()

◆ cfind()

◆ lookup()

◆ names() [1/4]

◆ names() [2/4]

◆ names() [3/4]

◆ names() [4/4]

◆ toc()

◆ writeData()

◆ writeObject()

◆ findIndices()

◆ lookupPtr()