surfZoneIOList Class Reference

IOobject for a surfZoneList. More...

Inheritance diagram for surfZoneIOList:

Collaboration diagram for surfZoneIOList:

Public Member Functions
	TypeNameNoDebug ("surfZoneList")
	surfZoneIOList (const IOobject &io)
	surfZoneIOList (const IOobject &io, const UList< surfZone > &content)
	surfZoneIOList (const IOobject &io, surfZoneList &&content)
virtual	~surfZoneIOList ()=default
bool	writeData (Ostream &os) const
void	operator= (const surfZoneIOList &rhs)
void	operator= (const UList< T > &a)
void	operator= (const List< T > &list)
void	operator= (const SLList< T > &list)
template<class Addr >
void	operator= (const IndirectListBase< T, Addr > &list)
template<unsigned N>
void	operator= (const FixedList< T, N > &list)
void	operator= (std::initializer_list< T > list)
void	operator= (const T &val)
void	operator= (const Foam::zero)
void	operator= (List< T > &&list)
template<int SizeMin>
void	operator= (DynamicList< T, SizeMin > &&list)
void	operator= (SortableList< T > &&list)
void	operator= (SLList< T > &&list)
template<class T >
void	operator= (const UList< T > &a)
template<class T >
void	operator= (const List< T > &list)
template<class T >
void	operator= (const SLList< T > &list)
template<class T >
void	operator= (std::initializer_list< T > list)
template<class T >
void	operator= (List< T > &&list)
template<class T >
void	operator= (SortableList< T > &&list)
template<class T >
void	operator= (SLList< T > &&list)
template<class T >
void	operator= (const T &val)
template<class T >
void	operator= (const Foam::zero)
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	writeObject (IOstreamOption streamOpt, const bool valid) const
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 List
constexpr	List () noexcept
	List (const label len)
	List (const label len, const T &val)
	List (const label len, const Foam::zero)
	List (const Foam::one, const T &val)
	List (const Foam::one, T &&val)
	List (const Foam::one, const Foam::zero)
	List (const List< T > &a)
	List (const UList< T > &a)
	List (List< T > &a, bool reuse)
	List (const UList< T > &list, const labelUList &indices)
template<unsigned N>
	List (const UList< T > &list, const FixedList< label, N > &indices)
template<unsigned N>
	List (const FixedList< T, N > &list)
	List (const PtrList< T > &list)
	List (const SLList< T > &list)
template<class Addr >
	List (const IndirectListBase< T, Addr > &list)
	List (std::initializer_list< T > list)
	List (List< T > &&list)
template<int SizeMin>
	List (DynamicList< T, SizeMin > &&list)
	List (SortableList< T > &&list)
	List (SLList< T > &&list)
	List (Istream &is)
autoPtr< List< T > >	clone () const
	~List ()
void	clear ()
void	resize (const label len)
void	resize (const label len, const T &val)
void	resize_nocopy (const label len)
void	setSize (const label n)
void	setSize (const label n, const T &val)
void	append (const T &val)
void	append (T &&val)
void	append (const UList< T > &list)
template<class Addr >
void	append (const IndirectListBase< T, Addr > &list)
label	appendUniq (const T &val)
void	transfer (List< T > &list)
template<int SizeMin>
void	transfer (DynamicList< T, SizeMin > &list)
void	transfer (SortableList< T > &list)
T &	newElmt (const label i)
void	operator= (const UList< T > &a)
void	operator= (const List< T > &list)
void	operator= (const SLList< T > &list)
template<class Addr >
void	operator= (const IndirectListBase< T, Addr > &list)
template<unsigned N>
void	operator= (const FixedList< T, N > &list)
void	operator= (std::initializer_list< T > list)
void	operator= (const T &val)
void	operator= (const Foam::zero)
void	operator= (List< T > &&list)
template<int SizeMin>
void	operator= (DynamicList< T, SizeMin > &&list)
void	operator= (SortableList< T > &&list)
void	operator= (SLList< T > &&list)
Istream &	readList (Istream &is)
void	shallowCopy (const UList< T > &)=delete
template<class TypeT = T>
std::enable_if< std::is_same< bool, TypeT >::value, bool >::type	set (const label i, bool val=true)
template<class T >
	List (const label len)
template<class T >
	List (const label len, const T &val)
template<class T >
	List (const label len, const Foam::zero)
template<class T >
	List (const Foam::one, const T &val)
template<class T >
	List (const Foam::one, T &&val)
template<class T >
	List (const Foam::one, const Foam::zero)
template<class T >
	List (const UList< T > &a)
template<class T >
	List (const List< T > &a)
template<class T >
	List (List< T > &a, bool reuse)
template<class T >
	List (const UList< T > &list, const labelUList &indices)
template<class T >
	List (const PtrList< T > &list)
template<class T >
	List (const SLList< T > &list)
template<class T >
	List (std::initializer_list< T > list)
template<class T >
	List (List< T > &&list)
template<class T >
	List (SortableList< T > &&list)
template<class T >
	List (SLList< T > &&list)
template<class T >
void	transfer (List< T > &list)
template<class T >
void	transfer (SortableList< T > &list)
template<class T >
void	operator= (const UList< T > &a)
template<class T >
void	operator= (const List< T > &list)
template<class T >
void	operator= (const SLList< T > &list)
template<class T >
void	operator= (std::initializer_list< T > list)
template<class T >
void	operator= (List< T > &&list)
template<class T >
void	operator= (SortableList< T > &&list)
template<class T >
void	operator= (SLList< T > &&list)
Istream &	readList (Istream &is)
template<class T >
constexpr	List () noexcept
void	resize (const label newLen)
template<class T >
void	append (const T &val)
template<class T >
void	append (T &&val)
template<class T >
void	append (const UList< T > &list)
template<class T >
void	operator= (const T &val)
template<class T >
void	operator= (const Foam::zero)
template<class T >
	List (Istream &is)
Istream &	readList (Istream &is)

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 }
Public Types inherited from List
typedef SubList< T >	subList
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)
Static Public Member Functions inherited from List
static const List< T > &	null ()
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)
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

IOobject for a surfZoneList.

Source files

• surfZoneIOList.H
• surfZoneIOList.C

Definition at line 49 of file surfZoneIOList.H.

Constructor & Destructor Documentation

surfZoneIOList() [1/3]

surfZoneIOList ( const IOobject &  io )

explicit

Definition at line 35 of file surfZoneIOList.C.

References IOstream::check(), dict, Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, forAll, FUNCTION_NAME, Foam::nl, IOobject::objectPath(), and List::resize().

Here is the call graph for this function:

surfZoneIOList() [2/3]

surfZoneIOList	(	const IOobject &	io,
		const UList< surfZone > &	content
	)

Definition at line 84 of file surfZoneIOList.C.

surfZoneIOList() [3/3]

surfZoneIOList	(	const IOobject &	io,
		surfZoneList &&	content
	)

Definition at line 95 of file surfZoneIOList.C.

~surfZoneIOList()

virtual ~surfZoneIOList ( )

virtualdefault

Member Function Documentation

TypeNameNoDebug()

TypeNameNoDebug

(

"surfZoneList"

)

writeData()

bool writeData ( Ostream &  os ) const

virtual

Implements regIOobject.

Definition at line 107 of file surfZoneIOList.C.

References token::BEGIN_LIST, Foam::decrIndent(), token::END_LIST, Foam::incrIndent(), Foam::nl, and os().

Referenced by Foam::operator<<().

Here is the call graph for this function:

Here is the caller graph for this function:

operator=() [1/22]

void operator=

(

const surfZoneIOList &

rhs

)

Definition at line 134 of file surfZoneIOList.C.

References List::operator=().

Here is the call graph for this function:

operator=() [2/22]

void operator=

operator=() [3/22]

void operator=

operator=() [4/22]

void operator=

operator=() [5/22]

void operator=

(

class Addr

)

Definition at line 576 of file List.C.

operator=() [6/22]

void operator=

(

unsigned

N

)

Definition at line 560 of file List.C.

operator=() [7/22]

void operator=

operator=() [8/22]

void operator=

inline

operator=() [9/22]

void operator=

inline

operator=() [10/22]

void operator=

operator=() [11/22]

void operator=

(

int

SizeMin

)

Definition at line 628 of file List.C.

operator=() [12/22]

void operator=

operator=() [13/22]

void operator=

operator=() [14/22]

void operator=

(

class T

)

Definition at line 491 of file List.C.

operator=() [15/22]

void operator=

(

class T

)

Definition at line 527 of file List.C.

operator=() [16/22]

void operator=

(

class T

)

Definition at line 539 of file List.C.

operator=() [17/22]

void operator=

(

class T

)

Definition at line 595 of file List.C.

operator=() [18/22]

void operator=

(

class T

)

Definition at line 615 of file List.C.

operator=() [19/22]

void operator=

(

class T

)

Definition at line 635 of file List.C.

operator=() [20/22]

void operator=

(

class T

)

Definition at line 642 of file List.C.

operator=() [21/22]

void operator= ( class T  )

inline

Definition at line 242 of file ListI.H.

operator=() [22/22]

void operator= ( class T  )

inline

Definition at line 249 of file ListI.H.

---

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

• src/surfMesh/surfZone/surfZoneIOList.H
• src/surfMesh/surfZone/surfZoneIOList.C