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 }
	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...

Public Types inherited from SubField< Type >
typedef pTraits< Type >::cmptType	cmptType
	Component type. More...

Public Member Functions
	SubDimensionedField (const SubField< Type > &sfield)
	Construct from a SubField. More...

	SubDimensionedField (const UList< Type > &list, const label subSize)
	Construct from a UList and size. More...

	SubDimensionedField (const UList< Type > &list, const label subSize, const label startIndex)
	Construct from a UList start and end indices. More...

	SubDimensionedField (const UList< Type > &list, const labelRange &range)
	Construct from UList and a (start,size) range. More...

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

	SubDimensionedField (const SubDimensionedField< cmptType, GeoMesh > &sfield)
	Construct as copy. More...

tmp< DimensionedField< cmptType, GeoMesh > >	component (const direction d) const
	Return a component field of the field. More...

tmp< DimensionedField< Type, GeoMesh > >	T () const
	Return the field transpose (only defined for second rank tensors) More...

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

	operator const DimensionedField< Type, GeoMesh > & () const
	Allow cast to a const DimensionedField<Type, GeoMesh>&. 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	writeData (Ostream &) const =0
	Pure virtual writeData function. More...

virtual bool	writeObject (IOstreamOption streamOpt, const bool valid) const
	Write using stream options. 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...

	IOobject (const IOobject &io, readOption, writeOption)
	Copy construct, resetting io options. 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 SubField< Type >
	SubField (const SubField< Type > &sfield)
	Copy construct (shallow copy) More...

	SubField (const SubList< Type > &list)
	Copy construct from SubList. More...

	SubField (const UList< Type > &list)
	Construct from UList, the entire size. More...

	SubField (const UList< Type > &list, const label subSize)
	Construct from UList with a given sub-list size, start at 0. More...

	SubField (const UList< Type > &list, const label subSize, const label startIndex)
	Construct from UList with a given size and start index. More...

	SubField (const UList< Type > &list, const labelRange &range)
	Construct from UList and a (start,size) range. More...

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

tmp< Field< cmptType > >	component (const direction) const
	Return a component field of the field. More...

tmp< Field< Type > >	T () const
	Return the field transpose (only defined for second rank tensors) More...

	operator const Foam::Field< Type > & () const
	Allow cast to a const Field<Type>&. More...

void	operator= (const SubField< Type > &)
	Copy assign via UList operator. Takes linear time. More...

void	operator= (const Field< Type > &)
	Copy assign via UList operator. Takes linear time. More...

void	operator= (const Type &val)
	Assign all entries to the given value. More...

void	operator= (const Foam::zero)
	Assign all entries to zero. More...

template<class Form , direction Ncmpts>
void	operator= (const VectorSpace< Form, Type, Ncmpts > &rhs)
	Copy assign via UList operator. Takes linear time. More...

void	operator+= (const Type &val)
	Add value to each entry. More...

void	operator-= (const Type &val)
	Subtract value from each entry. More...

void	operator*= (const scalar &s)
	Multiply each entry by value. More...

void	operator/= (const scalar &s)
	Divide each entry by value. More...

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

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

template<class Type >
static Type &	store (autoPtr< Type > &ptr)
	Transfer pointer ownership to its registry. More...

template<class Type >
static Type &	store (autoPtr< Type > &&ptr)
	Transfer pointer ownership to its registry. More...

template<class Type >
static Type &	store (refPtr< Type > &ptr)
	Transfer pointer ownership to its registry. More...

template<class Type >
static Type &	store (refPtr< Type > &&ptr)
	Transfer pointer ownership to its registry. More...

template<class Type >
static Type &	store (tmp< Type > &ptr)
	Transfer pointer ownership to its registry. More...

template<class Type >
static Type &	store (tmp< Type > &&ptr)
	Transfer pointer ownership 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 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...

Static Public Member Functions inherited from SubField< Type >
static const SubField< Type > &	null ()
	Return a null SubField. More...

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

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

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 57 of file SubDimensionedField.H.

Member Typedef Documentation

◆ Mesh

typedef GeoMesh::Mesh Mesh

Definition at line 67 of file SubDimensionedField.H.

◆ cmptType

typedef Field<Type>::cmptType cmptType

Definition at line 68 of file SubDimensionedField.H.

Constructor & Destructor Documentation

◆ SubDimensionedField() [1/6]

SubDimensionedField ( const SubField< Type > & sfield )

inline

Construct from a SubField.

Definition at line 32 of file SubDimensionedFieldI.H.

◆ SubDimensionedField() [2/6]

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

inline

Construct from a UList and size.

Definition at line 42 of file SubDimensionedFieldI.H.

◆ SubDimensionedField() [3/6]

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

inline

Construct from a UList start and end indices.

Definition at line 53 of file SubDimensionedFieldI.H.

◆ SubDimensionedField() [4/6]

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

inline

Construct from UList and a (start,size) range.

The range is subsetted with the list size itself to ensure that the result always addresses a valid section of the list.

Definition at line 65 of file SubDimensionedFieldI.H.

◆ SubDimensionedField() [5/6]

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

inline

Construct from UList and a (start,size) range, but bypassing run-time range checking.

Definition at line 76 of file SubDimensionedFieldI.H.

◆ SubDimensionedField() [6/6]

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

inline

Construct as copy.

Member Function Documentation

◆ null()

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

inlinestatic

Return a null SubDimensionedField.

Definition at line 100 of file SubDimensionedFieldI.H.

◆ component()

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

inline

Return a component field of the field.

◆ T()

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

inline

Return the field transpose (only defined for second rank tensors)

Definition at line 126 of file SubDimensionedFieldI.H.

◆ operator=()

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

inline

Assignment.

Definition at line 139 of file SubDimensionedFieldI.H.

References SubField< Type >::operator=().

Here is the call graph for this function:

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

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

inline

Allow cast to a const DimensionedField<Type, GeoMesh>&.

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 >