SubDimensionedField is a DimensionedField obtained as a section of another DimensionedField. More...

Inheritance diagram for SubDimensionedField< Type, GeoMesh >:

Collaboration diagram for SubDimensionedField< Type, GeoMesh >:

Public Types
typedef GeoMesh::Mesh	Mesh

typedef Field< Type >::cmptType	cmptType

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 SubField< Type >
typedef pTraits< Type >::cmptType	cmptType

Public Member Functions
	SubDimensionedField (const SubField< Type > &sfield)

	SubDimensionedField (const UList< Type > &list, const label subSize)

	SubDimensionedField (const UList< Type > &list, const label subSize, const label startIndex)

	SubDimensionedField (const UList< Type > &list, const labelRange &range)

	SubDimensionedField (const labelRange &range, const UList< Type > &list)

	SubDimensionedField (const SubDimensionedField< cmptType, GeoMesh > &sfield)

tmp< DimensionedField< cmptType, GeoMesh > >	component (const direction d) const

tmp< DimensionedField< Type, GeoMesh > >	T () const

void	operator= (const SubDimensionedField< Type, GeoMesh > &rhs)

	operator const DimensionedField< Type, GeoMesh > & () 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	writeData (Ostream &) const =0

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 SubField< Type >
	SubField () noexcept=default

	SubField (const SubField< Type > &sfield)

	SubField (const SubList< Type > &list)

	SubField (const UList< Type > &list)

	SubField (const UList< Type > &list, const label subSize)

	SubField (const UList< Type > &list, const label subSize, const label startIndex)

	SubField (const UList< Type > &list, const labelRange &range)

	SubField (const labelRange &range, const UList< Type > &list)

tmp< Field< cmptType > >	component (const direction) const

tmp< Field< Type > >	T () const

	operator const Foam::Field< Type > & () const

void	operator= (const SubField< Type > &)

void	operator= (const Field< Type > &)

void	operator= (const Type &val)

void	operator= (const Foam::zero)

void	operator= (const VectorSpace< Form, Type, Ncmpts > &rhs)

void	operator= (const SubField< Type > &rhs)

void	operator= (const Field< Type > &rhs)

void	operator= (const Type &val)

void	operator= (const Foam::zero)

void	operator+= (const Type &val)

void	operator-= (const Type &val)

void	operator*= (const scalar &s)

void	operator/= (const scalar &s)

Static Public Member Functions
static const SubDimensionedField< Type, GeoMesh > &	null ()

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 SubField< Type >
static const SubField< Type > &	null ()

Additional Inherited Members
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

template<class Type, class GeoMesh>
class Foam::SubDimensionedField< Type, GeoMesh >

SubDimensionedField is a DimensionedField obtained as a section of another DimensionedField.

Thus it is itself unallocated so that no storage is allocated or deallocated during its use. To achieve this behaviour, SubDimensionedField is derived from SubField rather than Field.

Source files

Definition at line 53 of file SubDimensionedField.H.

Member Typedef Documentation

◆ Mesh

typedef GeoMesh::Mesh Mesh

Definition at line 63 of file SubDimensionedField.H.

◆ cmptType

typedef Field<Type>::cmptType cmptType

Definition at line 64 of file SubDimensionedField.H.

Constructor & Destructor Documentation

◆ SubDimensionedField() [1/6]

SubDimensionedField ( const SubField< Type > & sfield )

inline

Definition at line 25 of file SubDimensionedFieldI.H.

◆ SubDimensionedField() [2/6]

SubDimensionedField	(	const UList< Type > &	list,
		const label	subSize
	)

inline

Definition at line 35 of file SubDimensionedFieldI.H.

◆ SubDimensionedField() [3/6]

SubDimensionedField	(	const UList< Type > &	list,
		const label	subSize,
		const label	startIndex
	)

inline

Definition at line 46 of file SubDimensionedFieldI.H.

◆ SubDimensionedField() [4/6]

SubDimensionedField	(	const UList< Type > &	list,
		const labelRange &	range
	)

inline

Definition at line 58 of file SubDimensionedFieldI.H.

◆ SubDimensionedField() [5/6]

SubDimensionedField	(	const labelRange &	range,
		const UList< Type > &	list
	)

inline

Definition at line 69 of file SubDimensionedFieldI.H.

◆ SubDimensionedField() [6/6]

SubDimensionedField ( const SubDimensionedField< cmptType, GeoMesh > & sfield )

inline

Member Function Documentation

◆ null()

const Foam::SubDimensionedField< Type, GeoMesh > & null

inlinestatic

Definition at line 93 of file SubDimensionedFieldI.H.

◆ component()

tmp<DimensionedField<cmptType, GeoMesh> > component ( const direction d ) const

inline

◆ T()

Foam::tmp< Foam::DimensionedField< Type, GeoMesh > > T

inline

Definition at line 119 of file SubDimensionedFieldI.H.

◆ operator=()

void operator= ( const SubDimensionedField< Type, GeoMesh > & rhs )

inline

Definition at line 132 of file SubDimensionedFieldI.H.

References SubField::operator=().

Here is the call graph for this function:

◆ operator const DimensionedField< Type, GeoMesh > &()

operator const DimensionedField< Type, GeoMesh > & ( ) const

inline

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

src/OpenFOAM/fields/DimensionedFields/DimensionedField/SubDimensionedField.H
src/OpenFOAM/fields/DimensionedFields/DimensionedField/SubDimensionedFieldI.H

Public Types

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

template<class Type, class GeoMesh> class Foam::SubDimensionedField< Type, GeoMesh >

Member Typedef Documentation

◆ Mesh

◆ cmptType

Constructor & Destructor Documentation

◆ SubDimensionedField() [1/6]

◆ SubDimensionedField() [2/6]

◆ SubDimensionedField() [3/6]

◆ SubDimensionedField() [4/6]

◆ SubDimensionedField() [5/6]

◆ SubDimensionedField() [6/6]

Member Function Documentation

◆ null()

◆ component()

◆ T()

◆ operator=()

◆ operator const DimensionedField< Type, GeoMesh > &()

template<class Type, class GeoMesh>
class Foam::SubDimensionedField< Type, GeoMesh >