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 regIOobject
enum	fileCheckTypes { timeStamp, timeStampMaster, inotify, inotifyMaster }
	Types of communications. More...

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

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

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

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

Public Member Functions
	SubDimensionedField (const SubField< Type > &slist)
	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 SubDimensionedField< cmptType, GeoMesh > &sfield)
	Construct as copy. More...

tmp< DimensionedField< cmptType, GeoMesh > >	component (const direction) 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 > &)
	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 &, const bool isTime=false)
	Construct from IOobject. Optional flag for if IOobject is the. More...

	regIOobject (const regIOobject &)
	Construct as copy. More...

	regIOobject (const regIOobject &, bool registerCopy)
	Construct as copy, transferring registry registration to copy. More...

	regIOobject (const word &newName, const regIOobject &, bool registerCopy)
	Construct as copy with new name, transfering registry registration. More...

	regIOobject (const IOobject &, const regIOobject &)
	Construct as copy with new IO parameters. More...

virtual	~regIOobject ()
	Destructor. More...

bool	checkIn ()
	Add object to registry. More...

bool	checkOut ()
	Remove object from registry. More...

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

void	store ()
	Transfer ownership of this object to its registry. More...

void	release ()
	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 up to date (obviously) More...

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

Istream &	readStream (const word &)
	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...

label	watchIndex () const
	Return file-monitoring handle. More...

label &	watchIndex ()
	Return file-monitoring handle. More...

virtual bool	modified () const
	Return true if the object's file (or files for objectRegistry) More...

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

virtual bool	writeData (Ostream &) const =0
	Pure virtual writaData function. More...

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

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

void	operator= (const IOobject &)

Public Member Functions inherited from IOobject
	TypeName ("IOobject")
	Runtime type information. 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)
	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)
	Construct from path, registry, io options. More...

	IOobject (const IOobject &io, const word &name)
	Construct as copy resetting name. More...

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

virtual	~IOobject ()
	Destructor. More...

const Time &	time () const
	Return time. More...

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

const word &	name () const
	Return name. More...

const word &	headerClassName () const
	Return name of the class name read from header. More...

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

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

bool &	registerObject ()
	Register object created from this IOobject with registry if true. More...

bool	registerObject () const
	Register object created from this IOobject with registry if true. More...

readOption	readOpt () const

readOption &	readOpt ()

writeOption	writeOpt () const

writeOption &	writeOpt ()

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
	Return complete path. More...

fileName	path (const word &instance, const fileName &local="") const
	Return complete path with alternative instance and local. More...

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

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

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

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

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

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

template<class Name >
Foam::word	groupName (Name name, const word &group)

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

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

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

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

	SubField (const SubField< Type > &)
	Construct as copy. More...

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

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

	operator const Field< Type > & () const
	Allow cast to a const Field<Type>&. 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 *)
	Transfer ownership of the given object pointer to its registry. More...

template<class Type >
static Type &	store (autoPtr< Type > &)
	Transfer ownership of the given object pointer 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 Name >
static word	groupName (Name name, const word &group)

template<class Stream >
static Stream &	writeBanner (Stream &os, bool noHint=false)
	Write the standard OpenFOAM file/dictionary banner. More...

template<class Stream >
static Stream &	writeDivider (Stream &os)
	Write the standard file section divider. More...

template<class Stream >
static Stream &	writeEndDivider (Stream &os)
	Write the standard end file divider. More...

static void	replaceFileName (const word &from, const word &to)

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 const NamedEnum< fileCheckTypes, 4 >	fileCheckTypesNames

static int	fileModificationSkew

static fileCheckTypes	fileModificationChecking

Protected Member Functions inherited from IOobject
Istream *	objectStream ()
	Construct and return an IFstream for the object. More...

Istream *	objectStream (const fileName &)
	Construct and return an IFstream for the object given the. More...

void	setBad (const string &)
	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 55 of file SubDimensionedField.H.

Member Typedef Documentation

◆ Mesh

typedef GeoMesh::Mesh Mesh

Definition at line 65 of file SubDimensionedField.H.

◆ cmptType

typedef Field<Type>::cmptType cmptType

Definition at line 66 of file SubDimensionedField.H.

Constructor & Destructor Documentation

◆ SubDimensionedField() [1/4]

SubDimensionedField ( const SubField< Type > & slist )

inline

Construct from a SubField.

Definition at line 30 of file SubDimensionedFieldI.H.

◆ SubDimensionedField() [2/4]

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

inline

Construct from a UList and size.

Definition at line 39 of file SubDimensionedFieldI.H.

◆ SubDimensionedField() [3/4]

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

inline

Construct from a UList start and end indices.

Definition at line 50 of file SubDimensionedFieldI.H.

◆ SubDimensionedField() [4/4]

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 75 of file SubDimensionedFieldI.H.

◆ component()

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

inline

Return a component field of the field.

◆ T()

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

inline

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

Definition at line 101 of file SubDimensionedFieldI.H.

◆ operator=()

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

inline

Assignment.

Definition at line 114 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

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/4]

◆ SubDimensionedField() [2/4]

◆ SubDimensionedField() [3/4]

◆ SubDimensionedField() [4/4]

Member Function Documentation

◆ null()

◆ component()

◆ T()

◆ operator=()

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

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