Specialisation of DimensionedField that holds a slice of a given field so that it acts as a DimensionedField. More...

Inheritance diagram for SlicedDimensionedField< Type, GeoMesh >:

Collaboration diagram for SlicedDimensionedField< Type, GeoMesh >:

Public Types
typedef GeoMesh::Mesh	Mesh
	Type of mesh on which this SlicedDimensionedField is instantiated. More...

Public Types inherited from DimensionedField< Type, GeoMesh >
typedef GeoMesh::Mesh	Mesh
	Type of mesh on which this DimensionedField is instantiated. More...

typedef Field< Type >	FieldType
	Type of the field from which this DimensionedField is derived. More...

typedef Field< Type >::cmptType	cmptType
	Component type of the elements of the field. More...

Public Types inherited from IOobject
enum	readOption : char { NO_READ = 0 , MUST_READ = 1 , MUST_READ_IF_MODIFIED = 3 , READ_IF_PRESENT = 4 }
	Enumeration defining the read options. More...

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

enum	objectState : char { GOOD , BAD }
	Enumeration defining the valid states of an IOobject. More...

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

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

typedef SubField< Type >	subField
	Declare type of subField. More...

Public Types inherited from List< Type >
typedef SubList< Type >	subList
	Declare type of subList. More...

Public Types inherited from UList< T >
typedef T	value_type
	The value type the list contains. More...

typedef T *	pointer
	The pointer type for non-const access to value_type items. More...

typedef const T *	const_pointer
	The pointer type for const access to value_type items. More...

typedef T &	reference
	The type used for storing into value_type objects. More...

typedef const T &	const_reference
	The type used for reading from constant value_type objects. More...

typedef T *	iterator
	Random access iterator for traversing a UList. More...

typedef const T *	const_iterator
	Random access iterator for traversing a UList. More...

typedef label	size_type
	The type to represent the size of a UList. More...

typedef label	difference_type
	The difference between iterator objects. More...

typedef std::reverse_iterator< iterator >	reverse_iterator
	Reverse iterator (non-const access) More...

typedef std::reverse_iterator< const_iterator >	const_reverse_iterator
	Reverse iterator (const access) More...

Public Member Functions
	SlicedDimensionedField (const IOobject &io, const Mesh &mesh, const dimensionSet &ds, const Field< Type > &iField)
	Construct from components and field to slice. More...

	~SlicedDimensionedField ()
	Destructor. More...

Public Member Functions inherited from DimensionedField< Type, GeoMesh >
	TypeName ("DimensionedField")
	Runtime type information. More...

	DimensionedField (const IOobject &io, const Mesh &mesh, const dimensionSet &dims, const Field< Type > &field)
	Construct from components, copy initial field content. More...

	DimensionedField (const IOobject &io, const Mesh &mesh, const dimensionSet &dims, Field< Type > &&field)
	Construct from components, transferring initial field content. More...

	DimensionedField (const IOobject &io, const Mesh &mesh, const dimensionSet &dims, List< Type > &&field)
	Construct from components, transferring initial field content. More...

	DimensionedField (const IOobject &io, const Mesh &mesh, const dimensionSet &dims, const tmp< Field< Type > > &tfield)
	Construct from components, copy or transfer tmp content. More...

	DimensionedField (const IOobject &io, const Mesh &mesh, const dimensionSet &dims, const bool checkIOFlags=true)

	DimensionedField (const IOobject &io, const Mesh &mesh, const dimensioned< Type > &dt, const bool checkIOFlags=true)

	DimensionedField (const IOobject &io, const Mesh &mesh, const word &fieldDictEntry="value")
	Construct from Istream. More...

	DimensionedField (const IOobject &io, const Mesh &mesh, const dictionary &fieldDict, const word &fieldDictEntry="value")
	Construct from dictionary. More...

	DimensionedField (const DimensionedField< Type, GeoMesh > &df)
	Copy construct. More...

	DimensionedField (DimensionedField< Type, GeoMesh > &&df)
	Move construct. More...

	DimensionedField (DimensionedField< Type, GeoMesh > &df, bool reuse)
	Copy construct or reuse (move) as specified. More...

	DimensionedField (const tmp< DimensionedField< Type, GeoMesh > > &tdf)
	Construct from tmp<DimensionedField> deleting argument. More...

	DimensionedField (const IOobject &io, const DimensionedField< Type, GeoMesh > &df)
	Copy construct, resetting IO parameters. More...

	DimensionedField (const IOobject &io, DimensionedField< Type, GeoMesh > &&df)
	Move construct, resetting IO parameters. More...

	DimensionedField (const IOobject &io, DimensionedField< Type, GeoMesh > &df, bool reuse)
	Copy or move construct, resetting IO parameters. More...

	DimensionedField (const IOobject &io, const tmp< DimensionedField< Type, GeoMesh > > &tdf)

	DimensionedField (const word &newName, const DimensionedField< Type, GeoMesh > &df)
	Copy construct with a new name. More...

	DimensionedField (const word &newName, DimensionedField< Type, GeoMesh > &&df)
	Move construct with a new name. More...

	DimensionedField (const word &newName, DimensionedField< Type, GeoMesh > &df, bool reuse)
	Copy or move construct, resetting name. More...

	DimensionedField (const word &newName, const tmp< DimensionedField< Type, GeoMesh > > &tdf)
	Construct with a new name from tmp<DimensionedField> More...

tmp< DimensionedField< Type, GeoMesh > >	clone () const
	Clone. More...

virtual	~DimensionedField ()=default
	Destructor. More...

void	readField (const dictionary &fieldDict, const word &fieldDictEntry="value")

const Mesh &	mesh () const
	Return mesh. More...

const dimensionSet &	dimensions () const
	Return dimensions. More...

dimensionSet &	dimensions ()
	Return non-const access to dimensions. More...

const orientedType &	oriented () const noexcept
	Return oriented type. More...

orientedType &	oriented () noexcept
	Return non-const access to the oriented type. More...

void	setOriented (const bool oriented=true) noexcept
	Set the oriented flag. More...

const Field< Type > &	field () const
	Return field. More...

Field< Type > &	field ()
	Return field. More...

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

void	replace (const direction d, const DimensionedField< cmptType, GeoMesh > &df)
	Replace a component field of the field. More...

void	replace (const direction d, const tmp< DimensionedField< cmptType, GeoMesh > > &tdf)
	Replace a component field of the field. More...

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

dimensioned< Type >	average () const
	Calculate and return arithmetic average. More...

dimensioned< Type >	weightedAverage (const DimensionedField< scalar, GeoMesh > &weightField) const
	Calculate and return weighted average. More...

dimensioned< Type >	weightedAverage (const tmp< DimensionedField< scalar, GeoMesh > > &tweightField) const
	Calculate and return weighted average. More...

bool	writeData (Ostream &os, const word &fieldDictEntry) const

bool	writeData (Ostream &os) const
	Pure virtual writeData function. More...

void	operator= (const DimensionedField< Type, GeoMesh > &df)

void	operator= (const tmp< DimensionedField< Type, GeoMesh > > &tdf)

void	operator= (const dimensioned< Type > &dt)
	Assign dimensions and value. More...

void	operator+= (const DimensionedField< Type, GeoMesh > &df)

void	operator+= (const tmp< DimensionedField< Type, GeoMesh > > &tdf)

void	operator-= (const DimensionedField< Type, GeoMesh > &df)

void	operator-= (const tmp< DimensionedField< Type, GeoMesh > > &tdf)

void	operator*= (const DimensionedField< scalar, GeoMesh > &df)

void	operator*= (const tmp< DimensionedField< scalar, GeoMesh > > &tdf)

void	operator/= (const DimensionedField< scalar, GeoMesh > &df)

void	operator/= (const tmp< DimensionedField< scalar, GeoMesh > > &tdf)

void	operator+= (const dimensioned< Type > &dt)

void	operator-= (const dimensioned< Type > &dt)

void	operator*= (const dimensioned< scalar > &dt)

void	operator/= (const dimensioned< scalar > &dt)

const word	typeName ("volScalarField::Internal")

const word	typeName ("volVectorField::Internal")

const word	typeName ("volSphericalTensorField::Internal")

const word	typeName ("volSymmTensorField::Internal")

const word	typeName ("volTensorField::Internal")

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

	regIOobject (const IOobject &io, const bool isTimeObject=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	registered () const noexcept

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

bool	store ()

void	release (const bool unregister=false) noexcept
	Set object as not ownedByRegistry. More...

label	eventNo () const noexcept
	Event number at last update. More...

label &	eventNo () noexcept
	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...

const dictionary *	findMetaData () const noexcept
	Return pointer to meta-data or nullptr. More...

dictionary &	getMetaData () noexcept
	Get or create meta-data. More...

void	removeMetaData ()
	Remove meta-data. More...

virtual void	updateMetaData ()
	Update internal meta-data (eg, prior to writing) More...

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

bool	headerOk ()
	Read and check header info. Does not check the headerClassName. 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 noexcept
	Read access to file-monitoring handles. More...

labelList &	watchIndices () noexcept
	Write access to 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 (IOstreamOption::streamFormat fmt, IOstreamOption::versionNumber ver, IOstreamOption::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 rOpt=NO_READ, writeOption wOpt=NO_WRITE, bool registerObject=true, bool globalObject=false)
	Construct from name, instance, registry, io options. More...

	IOobject (const word &name, const fileName &instance, const fileName &local, const objectRegistry &registry, readOption rOpt=NO_READ, writeOption wOpt=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 rOpt=NO_READ, writeOption wOpt=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, const word &name, const fileName &local)
	Copy construct, resetting name and local component. More...

	IOobject (const IOobject &io, readOption rOpt, writeOption wOpt)
	Copy construct, resetting read/write options. More...

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

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

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

const Time &	time () const
	Return Time associated with the objectRegistry. More...

const word &	name () const noexcept
	Return the object name. More...

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

word &	headerClassName () noexcept
	Return non-constant access to the class name read from header. More...

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

string &	note () noexcept
	Modifiable access to the optional note. More...

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

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

bool	registerObject (bool on) noexcept
	Change registration preference, return previous value. More...

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

bool	globalObject (bool on) noexcept
	Change global-object status, return previous value. More...

unsigned	labelByteSize () const noexcept
	The sizeof (label) in bytes, possibly read from the header. More...

unsigned	scalarByteSize () const noexcept
	The sizeof (scalar) in bytes, possibly read from the header. More...

bool	hasHeaderClass () const noexcept
	True if headerClassName() is non-empty (after reading) More...

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

template<class Type >
bool	isHeaderClassName () const
	Same as isHeaderClass() More...

virtual const dictionary *	findMetaData () const noexcept
	Return pointer to meta-data (if any) or nullptr. More...

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

readOption	readOpt (readOption opt) noexcept
	Change the read option, return previous value. More...

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

writeOption	writeOpt (writeOption opt) noexcept
	Change the write option, return previous value. 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
	Return the Time::rootPath() More...

const fileName &	caseName () const
	Return the Time::caseName() More...

const fileName &	instance () const noexcept
	Read access to instance path component. More...

fileName &	instance () noexcept
	Write access to instance path component. More...

const fileName &	local () const noexcept
	Read access to local path component. More...

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	objectRelPath () const
	The object path relative to the root. 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...

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)
	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 with current type() More...

bool	writeHeader (Ostream &os, const word &objectType) const
	Write header with override of type. More...

void	writeHeader (dictionary &dict, IOstreamOption streamOpt) const

void	writeHeader (dictionary &dict, const word &objectType, IOstreamOption streamOpt) const

bool	good () const noexcept
	Did last readHeader() succeed? More...

bool	bad () const noexcept
	Did last readHeader() fail? More...

InfoProxy< IOobject >	info () const
	Return info proxy, for printing information to a stream. More...

void	operator= (const IOobject &io)
	Copy assignment, copies all values (except the registry) More...

readOption &	readOpt () noexcept
	Access to the read option. More...

writeOption &	writeOpt () noexcept
	Access to the write option. More...

bool &	registerObject () noexcept
	Access to the register object option. More...

bool &	globalObject () noexcept
	Access to the global object option. More...

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

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

Public Member Functions inherited from Field< Type >
constexpr	Field () noexcept
	Default construct. More...

	Field (const label len)
	Construct given size. More...

	Field (const label len, const Type &val)
	Construct given size and initial value. More...

	Field (const label len, const Foam::zero)
	Construct given size and initial values of zero. More...

	Field (const Foam::one, const Type &val)
	Construct with length=1, copying the value as the only content. More...

	Field (const Foam::one, Type &&val)
	Construct with length=1, moving the value as the only content. More...

	Field (const Foam::one, const Foam::zero)
	Construct with length=1, initializing content to zero. More...

	Field (const Field< Type > &fld)
	Copy construct. More...

	Field (const UList< Type > &list)
	Copy construct from UList<Type> More...

template<class Addr >
	Field (const IndirectListBase< Type, Addr > &list)
	Copy construct from IndirectList. More...

	Field (Field< Type > &&fld)
	Move construct from Field. More...

	Field (List< Type > &&list)
	Move construct from List. More...

template<int SizeMin>
	Field (DynamicList< Type, SizeMin > &&list)
	Move construct from DynamicList. More...

	Field (const UList< Type > &mapF, const labelUList &mapAddressing)
	Construct by 1 to 1 mapping from the given field. More...

	Field (const tmp< Field< Type > > &tmapF, const labelUList &mapAddressing)
	Construct by 1 to 1 mapping from the given tmp field. More...

	Field (const UList< Type > &mapF, const labelListList &mapAddressing, const scalarListList &weights)
	Construct by interpolative mapping from the given field. More...

	Field (const tmp< Field< Type > > &tmapF, const labelListList &mapAddressing, const scalarListList &weights)
	Construct by interpolative mapping from the given tmp field. More...

	Field (const UList< Type > &mapF, const FieldMapper &map, const bool applyFlip=true)
	Construct by mapping from the given field. More...

	Field (const UList< Type > &mapF, const FieldMapper &map, const Type &defaultValue, const bool applyFlip=true)
	Construct by mapping from the given field. More...

	Field (const UList< Type > &mapF, const FieldMapper &map, const UList< Type > &defaultValues, const bool applyFlip=true)
	Construct by mapping from the given field. More...

	Field (const tmp< Field< Type > > &tmapF, const FieldMapper &map, const bool applyFlip=true)
	Construct by mapping from the given tmp field. More...

	Field (const tmp< Field< Type > > &tmapF, const FieldMapper &map, const Type &defaultValue, const bool applyFlip=true)

	Field (const tmp< Field< Type > > &tmapF, const FieldMapper &map, const UList< Type > &defaultValues, const bool applyFlip=true)

	Field (Field< Type > &fld, bool reuse)
	Copy construct or re-use as specified. More...

	Field (const tmp< Field< Type > > &tfld)
	Copy or move construct from tmp. More...

	Field (Istream &is)
	Construct from Istream. More...

	Field (const word &keyword, const dictionary &dict, const label len)
	Construct from a dictionary entry. More...

tmp< Field< Type > >	clone () const
	Clone. More...

void	map (const UList< Type > &mapF, const labelUList &mapAddressing)
	1 to 1 map from the given field More...

void	map (const tmp< Field< Type > > &tmapF, const labelUList &mapAddressing)
	1 to 1 map from the given tmp field More...

void	map (const UList< Type > &mapF, const labelListList &mapAddressing, const scalarListList &weights)
	Interpolative map from the given field. More...

void	map (const tmp< Field< Type > > &tmapF, const labelListList &mapAddressing, const scalarListList &weights)
	Interpolative map from the given tmp field. More...

void	map (const UList< Type > &mapF, const FieldMapper &map, const bool applyFlip=true)
	Map from the given field. More...

void	map (const tmp< Field< Type > > &tmapF, const FieldMapper &map, const bool applyFlip=true)
	Map from the given tmp field. More...

void	autoMap (const FieldMapper &map, const bool applyFlip=true)
	Map from self. More...

void	rmap (const UList< Type > &mapF, const labelUList &mapAddressing)
	1 to 1 reverse-map from the given field More...

void	rmap (const tmp< Field< Type > > &tmapF, const labelUList &mapAddressing)
	1 to 1 reverse-map from the given tmp field More...

void	rmap (const UList< Type > &mapF, const labelUList &mapAddressing, const UList< scalar > &weights)
	Interpolative reverse map from the given field. More...

void	rmap (const tmp< Field< Type > > &tmapF, const labelUList &mapAddressing, const UList< scalar > &weights)
	Interpolative reverse map from the given tmp field. More...

void	negate ()
	Inplace negate this field (negative). More...

void	normalise ()

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

void	replace (const direction, const UList< cmptType > &)
	Replace a component field of the field. More...

void	replace (const direction, const tmp< Field< cmptType > > &)
	Replace a component field of the field. More...

void	replace (const direction, const cmptType &)
	Replace a component field of the field. More...

template<class VSForm >
VSForm	block (const label start) const

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

void	writeEntry (const word &keyword, Ostream &os) const
	Write the field as a dictionary entry. More...

SubField< Type >	slice (const label pos, label len=-1)
	Return SubField slice (non-const access) - no range checking. More...

const SubField< Type >	slice (const label pos, label len=-1) const
	Return SubField slice (const access) - no range checking. More...

SubField< Type >	slice (const labelRange &range)
	Return SubField slice (non-const access) - with range checking. More...

const SubField< Type >	slice (const labelRange &range) const
	Return SubField slice (const access) - with range checking. More...

void	operator= (const Field< Type > &)
	Copy assignment. More...

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

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

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

template<class Addr >
void	operator= (const IndirectListBase< Type, Addr > &rhs)
	Copy assign from IndirectList. More...

void	operator= (Field< Type > &&rhs)
	Move assignment. More...

void	operator= (List< Type > &&rhs)

template<int SizeMin>
void	operator= (DynamicList< Type, SizeMin > &&rhs)

void	operator= (const Type &val)
	Value assignment. More...

void	operator= (const Foam::zero)

template<class Form , class Cmpt , direction nCmpt>
void	operator= (const VectorSpace< Form, Cmpt, nCmpt > &)

void	operator+= (const UList< Type > &)

void	operator+= (const tmp< Field< Type > > &)

void	operator-= (const UList< Type > &)

void	operator-= (const tmp< Field< Type > > &)

void	operator*= (const UList< scalar > &)

void	operator*= (const tmp< Field< scalar > > &)

void	operator/= (const UList< scalar > &)

void	operator/= (const tmp< Field< scalar > > &)

void	operator+= (const Type &)

void	operator-= (const Type &)

void	operator*= (const scalar &)

void	operator/= (const scalar &)

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

void	normalise ()

void	normalise ()

void	normalise ()
	Inplace normalise (float) vector field. More...

void	normalise ()
	Inplace normalise (double) vector field. More...

Public Member Functions inherited from FieldBase
constexpr	FieldBase () noexcept
	Default construct, refCount zero. More...

Public Member Functions inherited from refCount
constexpr	refCount () noexcept
	Default construct, initializing count to 0. More...

int	count () const noexcept
	Return the current reference count. More...

bool	unique () const noexcept
	Return true if the reference count is zero. More...

void	operator++ () noexcept
	Increment the reference count. More...

void	operator++ (int) noexcept
	Increment the reference count. More...

void	operator-- () noexcept
	Decrement the reference count. More...

void	operator-- (int) noexcept
	Decrement the reference count. More...

Public Member Functions inherited from List< Type >
constexpr	List () noexcept
	Default construct. More...

	List (const label len)
	Construct with given size. More...

	List (const label len, const Type &val)
	Construct with given size and value for all elements. More...

	List (const label len, const Foam::zero)
	Construct with given size initializing all elements to zero. More...

	List (const Foam::one, const Type &val)
	Construct with length=1, copying the value as the only content. More...

	List (const Foam::one, Type &&val)
	Construct with length=1, moving the value as the only content. More...

	List (const Foam::one, const Foam::zero)
	Construct with length=1, initializing content to zero. More...

	List (const List< Type > &a)
	Copy construct from list. More...

	List (const UList< Type > &a)
	Copy construct contents from list. More...

	List (List< Type > &a, bool reuse)
	Construct as copy or re-use as specified. More...

	List (const UList< Type > &list, const labelUList &indices)
	Copy construct subset of list. More...

	List (const UList< Type > &list, const FixedList< label, N > &indices)
	Copy construct subset of list. More...

	List (const FixedList< Type, N > &list)
	Construct as copy of FixedList<T, N> More...

	List (const PtrList< Type > &list)
	Construct as copy of PtrList<T> More...

	List (const SLList< Type > &list)
	Construct as copy of SLList<T> More...

	List (const IndirectListBase< Type, Addr > &list)
	Construct as copy of IndirectList contents. More...

	List (std::initializer_list< Type > list)
	Construct from an initializer list. More...

	List (List< Type > &&list)
	Move construct from List. More...

	List (DynamicList< Type, SizeMin > &&list)
	Move construct from DynamicList. More...

	List (SLList< Type > &&list)
	Move construct from SLList. More...

	List (Istream &is)
	Construct from Istream. More...

autoPtr< List< Type > >	clone () const
	Clone. More...

	~List ()
	Destructor. More...

void	clear ()
	Clear the list, i.e. set size to zero. More...

void	resize (const label len)
	Adjust allocated size of list. More...

void	resize (const label len, const Type &val)
	Adjust allocated size of list and set val for new elements. More...

void	resize (const label newLen)

void	resize_nocopy (const label len)
	Adjust allocated size of list without necessarily. More...

void	setSize (const label n)
	Alias for resize() More...

void	setSize (const label n, const Type &val)
	Alias for resize() More...

void	append (const Type &val)
	Append an element at the end of the list. More...

void	append (Type &&val)
	Move append an element at the end of the list. More...

void	append (const UList< Type > &list)
	Append a List to the end of this list. More...

void	append (const IndirectListBase< Type, Addr > &list)
	Append IndirectList contents at the end of this list. More...

label	appendUniq (const Type &val)
	Append an element if not already in the list. More...

void	transfer (List< Type > &list)

void	transfer (DynamicList< Type, SizeMin > &list)

Type &	newElmt (const label i)

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

void	operator= (const List< Type > &list)
	Assignment operator. Takes linear time. More...

void	operator= (const SLList< Type > &list)
	Assignment to SLList operator. Takes linear time. More...

void	operator= (const IndirectListBase< Type, Addr > &list)
	Assignment from IndirectList. Takes linear time. More...

void	operator= (const FixedList< Type, N > &list)
	Copy assignment from FixedList. More...

void	operator= (std::initializer_list< Type > list)
	Assignment to an initializer list. More...

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

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

void	operator= (List< Type > &&list)
	Move assignment. Takes constant time. More...

void	operator= (DynamicList< Type, SizeMin > &&list)
	Move assignment. Takes constant time. More...

void	operator= (SLList< Type > &&list)
	Move assignment. Takes constant time. More...

Istream &	readList (Istream &is)
	Read List from Istream, discarding contents of existing List. More...

Istream &	readList (Istream &is)

Istream &	readList (Istream &is)

void	shallowCopy (const UList< Type > &)=delete
	No shallowCopy permitted. More...

std::enable_if< std::is_same< bool, TypeT >::value, bool >::type	set (const label i, bool val=true)
	A bitSet::set() method for a list of bool. More...

Public Member Functions inherited from UList< T >
	UList (const UList< T > &)=default
	Copy construct. More...

constexpr	UList () noexcept
	Default construct, zero-sized and nullptr. More...

	UList (T *__restrict__ v, const label len) noexcept
	Construct from components. More...

label	fcIndex (const label i) const noexcept

label	rcIndex (const label i) const noexcept

const T &	fcValue (const label i) const
	Return forward circular value (ie, next value in the list) More...

T &	fcValue (const label i)
	Return forward circular value (ie, next value in the list) More...

const T &	rcValue (const label i) const
	Return reverse circular value (ie, previous value in the list) More...

T &	rcValue (const label i)
	Return reverse circular value (ie, previous value in the list) More...

const T *	cdata () const noexcept
	Return pointer to the underlying array serving as data storage. More...

T *	data () noexcept
	Return pointer to the underlying array serving as data storage. More...

const char *	cdata_bytes () const noexcept
	Return pointer to the underlying array serving as data storage,. More...

char *	data_bytes () noexcept
	Return pointer to the underlying array serving as data storage,. More...

T &	first ()
	Return the first element of the list. More...

const T &	first () const
	Return first element of the list. More...

T &	last ()
	Return the last element of the list. More...

const T &	last () const
	Return the last element of the list. More...

std::streamsize	size_bytes () const noexcept
	Number of contiguous bytes for the List data. More...

std::streamsize	byteSize () const

void	checkStart (const label start) const
	Check start is within valid range [0,size) More...

void	checkSize (const label size) const
	Check size is within valid range [0,size]. More...

void	checkRange (const label start, const label len) const
	Check that start and length define a valid range. More...

void	checkIndex (const label i) const
	Check index is within valid range [0,size) More...

bool	uniform () const
	True if all entries have identical values, and list is non-empty. More...

label	find (const T &val, label pos=0) const
	Find index of the first occurrence of the value. More...

label	rfind (const T &val, label pos=-1) const
	Find index of the last occurrence of the value. More...

bool	found (const T &val, label pos=0) const
	True if the value if found in the list. More...

void	moveFirst (const label i)
	Move element to the first position. More...

void	moveLast (const label i)
	Move element to the last position. More...

void	swapFirst (const label i)
	Swap element with the first element. Fatal on an empty list. More...

void	swapLast (const label i)
	Swap element with the last element. Fatal on an empty list. More...

void	shallowCopy (const UList< T > &list)
	Copy the pointer and size held by the given UList. More...

void	deepCopy (const UList< T > &list)
	Copy elements of the given UList. Sizes must match! More...

template<class Addr >
void	deepCopy (const IndirectListBase< T, Addr > &list)
	Copy elements of the given indirect list. Sizes must match! More...

SubList< T >	slice (const label pos, label len=-1)
	Return SubList slice (non-const access) - no range checking. More...

const SubList< T >	slice (const label pos, label len=-1) const
	Return SubList slice (const access) - no range checking. More...

SubList< T >	slice (const labelRange &range)
	Return SubList slice (non-const access) - with range checking. More...

const SubList< T >	slice (const labelRange &range) const
	Return SubList slice (const access) - with range checking. More...

T &	operator[] (const label i)
	Return element of UList. More...

const T &	operator[] (const label i) const
	Return element of constant UList. More...

	operator const Foam::List< T > & () const
	Allow cast to a const List<T>&. More...

void	operator= (const T &val)
	Assignment of all entries to the given value. More...

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

iterator	begin () noexcept
	Return an iterator to begin traversing the UList. More...

iterator	end () noexcept
	Return an iterator to end traversing the UList. More...

const_iterator	cbegin () const noexcept
	Return const_iterator to begin traversing the constant UList. More...

const_iterator	cend () const noexcept
	Return const_iterator to end traversing the constant UList. More...

const_iterator	begin () const noexcept
	Return const_iterator to begin traversing the constant UList. More...

const_iterator	end () const noexcept
	Return const_iterator to end traversing the constant UList. More...

reverse_iterator	rbegin ()
	Return reverse_iterator to begin reverse traversing the UList. More...

reverse_iterator	rend ()
	Return reverse_iterator to end reverse traversing the UList. More...

const_reverse_iterator	crbegin () const
	Return const_reverse_iterator to begin reverse traversing the UList. More...

const_reverse_iterator	crend () const
	Return const_reverse_iterator to end reverse traversing the UList. More...

const_reverse_iterator	rbegin () const
	Return const_reverse_iterator to begin reverse traversing the UList. More...

const_reverse_iterator	rend () const
	Return const_reverse_iterator to end reverse traversing the UList. More...

label	size () const noexcept
	The number of elements in the UList. More...

bool	empty () const noexcept
	True if the UList is empty (ie, size() is zero) More...

void	swap (UList< T > &list)
	Swap content with another UList of the same type in constant time. More...

bool	operator== (const UList< T > &a) const
	Equality operation on ULists of the same type. More...

bool	operator!= (const UList< T > &a) const
	The opposite of the equality operation. Takes linear time. More...

bool	operator< (const UList< T > &list) const
	Compare two ULists lexicographically. Takes linear time. More...

bool	operator> (const UList< T > &a) const
	Compare two ULists lexicographically. Takes linear time. More...

bool	operator<= (const UList< T > &a) const
	Return true if !(a > b). Takes linear time. More...

bool	operator>= (const UList< T > &a) const
	Return true if !(a < b). Takes linear time. More...

Istream &	readList (Istream &is)
	Read List contents from Istream. More...

void	writeEntry (const word &keyword, Ostream &os) const
	Write the List as a dictionary entry with keyword. More...

Ostream &	writeList (Ostream &os, const label shortLen=0) const
	Write List, with line-breaks in ASCII when length exceeds shortLen. More...

template<class TypeT = T>
std::enable_if< std::is_same< bool, TypeT >::value, bool >::type	test (const label i) const

template<class TypeT = T>
std::enable_if< std::is_same< bool, TypeT >::value, bool >::type	get (const label i) const

template<class TypeT = T>
std::enable_if< std::is_same< bool, TypeT >::value, bool >::type	unset (const label i)

Istream &	readList (Istream &is)

Ostream &	writeList (Ostream &os, const label) const

const bool &	operator[] (const label i) const

Foam::UPstream::commsStruct &	operator[] (const label procID)

const Foam::UPstream::commsStruct &	operator[] (const label procID) const

UPstream::commsStruct &	operator[] (const label procID)

const UPstream::commsStruct &	operator[] (const label procID) const

Ostream &	writeList (Ostream &os, const label) const

Istream &	readList (Istream &is)

Additional Inherited Members
Static Public Member Functions inherited from DimensionedField< Type, GeoMesh >
static const DimensionedField< Type, GeoMesh > &	null ()
	Return a NullObjectRef DimensionedField. More...

static tmp< DimensionedField< Type, GeoMesh > >	New (const word &name, const Mesh &mesh, const dimensionSet &ds, const Field< Type > &iField)

static tmp< DimensionedField< Type, GeoMesh > >	New (const word &name, const Mesh &mesh, const dimensionSet &ds, Field< Type > &&iField)

static tmp< DimensionedField< Type, GeoMesh > >	New (const word &name, const Mesh &mesh, const dimensionSet &ds)
	Return tmp field from name, mesh, dimensions. More...

static tmp< DimensionedField< Type, GeoMesh > >	New (const word &name, const Mesh &mesh, const dimensioned< Type > &dt)
	Return tmp field from name, mesh, dimensioned<Type>. More...

static tmp< DimensionedField< Type, GeoMesh > >	New (const word &newName, const tmp< DimensionedField< Type, GeoMesh > > &)
	Return renamed tmp field. 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	bannerEnabled () noexcept
	Status of output file banner. More...

static bool	bannerEnabled (bool on) noexcept
	Enable/disable output file banner. More...

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

static word	scopedName (const std::string &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, const bool noSyntaxHint=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 Field< Type >
static const Field< Type > &	null ()
	Return nullObject reference Field. More...

static autoPtr< Field< Type > >	New (Istream &is)
	Return a pointer to a new Field created on freestore. More...

template<class Type2 >
static tmp< Field< Type > >	NewCalculatedType (const Field< Type2 > &f)

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

Static Public Member Functions inherited from UList< T >
static const UList< T > &	null ()
	Return a UList reference to a nullObject. More...

static constexpr label	max_size () noexcept
	The size of the largest possible UList. More...

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

static float	fileModificationSkew
	Time skew (seconds) for file modification checks. More...

static int	maxFileModificationPolls
	Max number of times to poll for file modification changes. More...

Static Public Attributes inherited from FieldBase
static const char *const	typeName
	Typename for Field. More...

static bool	allowConstructFromLargerSize = false
	Permit read construct from a larger size. More...

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

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

Protected Member Functions inherited from UList< T >
void	setAddressableSize (const label n) noexcept
	Set addressed size to be inconsistent with allocated storage. More...

void	size (const label n)
	Older name for setAddressableSize. More...

void	writeEntry (Ostream &os) const
	Write the UList with its compound type. More...

labelRange	validateRange (const labelRange &requestedRange) const

UList< T > &	operator= (const UList< T > &)=delete
	No copy assignment (default: shallow copy) More...

void	writeEntry (Ostream &os) const

void	writeEntry (Ostream &os) const

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
	To flag master-only reading of objects. More...

Detailed Description

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

Specialisation of DimensionedField that holds a slice of a given field so that it acts as a DimensionedField.

Definition at line 50 of file SlicedDimensionedField.H.

Member Typedef Documentation

◆ Mesh

typedef GeoMesh::Mesh Mesh

Type of mesh on which this SlicedDimensionedField is instantiated.

Definition at line 59 of file SlicedDimensionedField.H.

Constructor & Destructor Documentation

◆ SlicedDimensionedField()

SlicedDimensionedField	(	const IOobject &	io,
		const Mesh &	mesh,
		const dimensionSet &	ds,
		const Field< Type > &	iField
	)

inline

Construct from components and field to slice.

Definition at line 65 of file SlicedDimensionedField.H.

References DimensionedField< Type, GeoMesh >::mesh(), UList< T >::shallowCopy(), and interfaceDefinitions::size().

Here is the call graph for this function:

◆ ~SlicedDimensionedField()

~SlicedDimensionedField ( )

inline

Destructor.

Definition at line 84 of file SlicedDimensionedField.H.

References UList< T >::shallowCopy().

Here is the call graph for this function:

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

src/OpenFOAM/fields/DimensionedFields/DimensionedField/SlicedDimensionedField.H

Public Types