Specialisation of GeometricField which holds slices of given complete fields in a form that they act as a GeometricField. More...

Inheritance diagram for SlicedGeometricField< Type, GeoMesh >:

[legend]

Collaboration diagram for SlicedGeometricField< Type, GeoMesh >:

[legend]

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

typedef SlicedDimensionedField< Type, GeoMesh >	Internal
	Type of the internal field from which this SlicedGeometricField is. More...

typedef GeoMesh::template PatchField< Type >	Patch
	Type of the patch field of which the Boundary is composed. More...

typedef Patch::Sliced	SlicedPatch
	Type of the sliced patch field of which the Boundary is composed. More...

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

typedef DimensionedField< Type, GeoMesh, PrimitiveField >	Internal
	Type of the internal field from which this GeometricField is derived. More...

typedef DimensionedField< Type, GeoMesh, PrimitiveField >	Base
	Type of the field from which this GeometricField is derived. More...

typedef GeoMesh::template PatchField< Type >	Patch
	Type of the patch field of which the Boundary is composed. More...

typedef GeometricBoundaryField< Type, GeoMesh, PrimitiveField >	Boundary
	Type of the boundary field. More...

typedef GeoMesh::template FieldSource< Type >	Source
	Type of the field source of which the Sources is composed. More...

typedef GeometricFieldSources< Type, GeoMesh, PrimitiveField >	Sources
	Type of the field sources. More...

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

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

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

typedef PrimitiveField< Type >	Base
	Type of the field from which this DimensionedField is derived. More...

typedef PrimitiveField< Type >::cmptType	cmptType
	Component type of the elements of the field. 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...

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

Public Member Functions
	SlicedGeometricField (const IOobject &, const Mesh &, const dimensionSet &, const Field< Type > &completeField, const bool preserveCouples=true)
	Construct from components and field to slice. More...

	SlicedGeometricField (const IOobject &, const Mesh &, const dimensionSet &, const Field< Type > &completeIField, const Field< Type > &completeBField, const bool preserveCouples=true, const bool preserveProcessorOnly=false)
	Construct from components and separate fields to slice for the. More...

	SlicedGeometricField (const IOobject &, const GeometricField< Type, GeoMesh > &, const bool preserveCouples=true)
	Construct from GeometricField. Reuses full internal and. More...

	SlicedGeometricField (const SlicedGeometricField< Type, GeoMesh > &)
	Copy constructor. More...

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

	~SlicedGeometricField ()
	Destructor. More...

tmp< Field< Type > >	splice () const
	Splice the sliced field and return the complete field. More...

void	correctBoundaryConditions ()
	Correct boundary field. More...

void	operator= (const SlicedGeometricField &)=delete
	Disallow default bitwise assignment. More...

void	operator= (const GeometricField< Type, GeoMesh > &)=delete
	Disallow standard assignment to GeometricField,. More...

void	operator= (const tmp< GeometricField< Type, GeoMesh >> &)=delete
	Disallow standard assignment to tmp<GeometricField>,. More...

void	correctBoundaryConditions ()

void	correctBoundaryConditions ()

void	correctBoundaryConditions ()

void	correctBoundaryConditions ()

void	correctBoundaryConditions ()

Public Member Functions inherited from GeometricField< Type, GeoMesh >
	GeometricField (const IOobject &, const Mesh &, const dimensionSet &, const word &patchFieldType=Patch::calculatedType())
	Constructor given IOobject, mesh, dimensions and patch field type. More...

	GeometricField (const IOobject &, const Mesh &, const dimensionSet &, const wordList &wantedPatchTypes, const wordList &actualPatchTypes=wordList(), const HashTable< word > &fieldSourceTypes=HashTable< word >())
	Constructor given IOobject, mesh, dimensions and patch field types. More...

	GeometricField (const IOobject &, const Mesh &, const dimensioned< Type > &, const word &patchFieldType=Patch::calculatedType())
	Constructor given IOobject, mesh, dimensioned<Type> More...

	GeometricField (const IOobject &, const Mesh &, const dimensioned< Type > &, const wordList &wantedPatchTypes, const wordList &actualPatchTypes=wordList(), const HashTable< word > &fieldSourceTypes=HashTable< word >())
	Constructor given IOobject, mesh, dimensioned<Type> More...

	GeometricField (const IOobject &, const Internal &, const PtrList< Patch > &, const HashPtrTable< Source > &=HashPtrTable< Source >())
	Constructor from components. More...

	GeometricField (const IOobject &, const Mesh &, const dimensionSet &, const PrimitiveField< Type > &, const PtrList< Patch > &, const HashPtrTable< Source > &=HashPtrTable< Source >())
	Constructor from components. More...

	GeometricField (const IOobject &, const Mesh &)
	Construct and read given IOobject. More...

	GeometricField (const IOobject &, const Mesh &, const dictionary &)
	Construct from dictionary. More...

	GeometricField (const GeometricField< Type, GeoMesh, PrimitiveField > &)
	Copy constructor. More...

	GeometricField (const GeometricField< Type, GeoMesh, PrimitiveField2 > &)
	Copy constructor. More...

	GeometricField (GeometricField< Type, GeoMesh, PrimitiveField > &&)
	Move constructor. More...

	GeometricField (const tmp< GeometricField< Type, GeoMesh, PrimitiveField >> &)
	Construct as copy of tmp. More...

	GeometricField (const IOobject &, const GeometricField< Type, GeoMesh, PrimitiveField2 > &)
	Construct as copy resetting IO parameters. More...

	GeometricField (const IOobject &, const tmp< GeometricField< Type, GeoMesh, PrimitiveField >> &)
	Construct as copy of tmp resetting IO parameters. More...

	GeometricField (const word &newName, const GeometricField< Type, GeoMesh, PrimitiveField2 > &)
	Construct as copy resetting name. More...

	GeometricField (const word &newName, const tmp< GeometricField< Type, GeoMesh, PrimitiveField >> &)
	Construct as copy of tmp resetting name. More...

	GeometricField (const IOobject &, const GeometricField< Type, GeoMesh, PrimitiveField2 > &, const word &patchFieldType)
	Construct as copy resetting IO parameters and patch field type. More...

	GeometricField (const IOobject &, const tmp< GeometricField< Type, GeoMesh, PrimitiveField >> &, const word &patchFieldType)
	Construct as copy of tmp resetting IO parameters. More...

	GeometricField (const IOobject &, const DimensionedField< Type, GeoMesh, PrimitiveField2 > &, const word &patchFieldType)
	Constructor from internal field and patch field type. More...

	GeometricField (const IOobject &, const tmp< Internal > &, const word &patchFieldType)
	Constructor from temporary internal field and patch field type. More...

	GeometricField (const IOobject &, const GeometricField< Type, GeoMesh, PrimitiveField2 > &, const wordList &patchFieldTypes, const wordList &actualPatchTypes=wordList(), const HashTable< word > &fieldSourceTypes=HashTable< word >())
	Construct as copy resetting IO parameters and patch field types. More...

	GeometricField (const IOobject &, const tmp< GeometricField< Type, GeoMesh, PrimitiveField >> &, const wordList &patchFieldTypes, const wordList &actualPatchTypes=wordList(), const HashTable< word > &fieldSourceTypes=HashTable< word >())
	Construct as copy of tmp resetting IO parameters. More...

	GeometricField (const IOobject &, const DimensionedField< Type, GeoMesh, PrimitiveField2 > &, const wordList &patchFieldTypes, const wordList &actualPatchTypes=wordList(), const HashTable< word > &fieldSourceTypes=HashTable< word >())
	Construct from IOobject, internal field and patch field types. More...

	GeometricField (const IOobject &, const tmp< Internal > &, const wordList &patchFieldTypes, const wordList &actualPatchTypes=wordList(), const HashTable< word > &fieldSourceTypes=HashTable< word >())
	Construct from IOobject, tmp internal field and patch field types. More...

	TypeName ("GeometricField")
	Runtime type information. More...

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

tmp< GeometricField< Type, GeoMesh, PrimitiveField > >	cloneUnSliced () const
	Clone un-sliced. More...

Foam::tmp< Foam::GeometricField< Type, GeoMesh, PrimitiveField > >	New (const word &newName, const GeometricField< Type, GeoMesh, PrimitiveField2 > &gf, const word &patchFieldType)

Foam::tmp< Foam::GeometricField< Type, GeoMesh, PrimitiveField > >	New (const word &newName, const DimensionedField< Type, GeoMesh, PrimitiveField2 > &df, const word &patchFieldType)

Foam::tmp< Foam::GeometricField< Type, GeoMesh, PrimitiveField > >	New (const word &newName, const GeometricField< Type, GeoMesh, PrimitiveField2 > &gf, const wordList &patchFieldTypes, const wordList &actualPatchTypes, const HashTable< word > &fieldSourceTypes)

Foam::tmp< Foam::GeometricField< Type, GeoMesh, PrimitiveField > >	New (const word &newName, const DimensionedField< Type, GeoMesh, PrimitiveField2 > &df, const wordList &patchFieldTypes, const wordList &actualPatchTypes, const HashTable< word > &fieldSourceTypes)

virtual	~GeometricField ()
	Destructor. More...

Internal &	internalFieldRef ()
	Return a reference to the dimensioned internal field. More...

const Internal &	internalField () const
	Return a const-reference to the dimensioned internal field. More...

const Internal &	v () const
	Return a const-reference to the dimensioned internal field. More...

Internal::FieldType &	primitiveFieldRef ()
	Return a reference to the primitive field. More...

const Internal::FieldType &	primitiveField () const
	Return a const-reference to the primitive field. More...

Boundary &	boundaryFieldRef ()
	Return a reference to the boundary field. More...

Boundary &	boundaryFieldRefNoStoreOldTimes ()
	Return a reference to the boundary field without storing old times. More...

const Boundary &	boundaryField () const
	Return const-reference to the boundary field. More...

Sources &	sourcesRef ()
	Return a reference to the sources. More...

const Sources &	sources () const
	Return const-reference to the sources. More...

void	storePrevIter () const
	Store the field as the previous iteration value. More...

void	clearPrevIter ()
	Delete the previous iteration field. More...

const GeometricField< Type, GeoMesh, Field > &	prevIter () const
	Return previous iteration field. More...

	USING_OLD_TIME_FIELD (GeometricField)
	Use old-time methods from the base class. More...

void	correctBoundaryConditions ()
	Correct boundary field. More...

void	reset (const GeometricField< Type, GeoMesh, PrimitiveField2 > &)
	Reset the field contents to the given field. More...

void	reset (const tmp< GeometricField< Type, GeoMesh, PrimitiveField >> &)
	Reset the field contents to the given tmp-field. More...

void	reset (const tmp< GeometricField< Type, GeoMesh, PrimitiveField2 >> &)
	Reset the field contents to the given tmp-field. More...

bool	needReference () const
	Does the field need a reference level for solution. More...

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

tmp< VolField< scalar > >	component (const direction) const

Foam::tmp< Foam::GeometricField< Foam::scalar, Foam::volMesh > >	component (const direction) const

bool	writeData (Ostream &) const
	WriteData member function required by regIOobject. More...

tmp< GeometricField< Type, GeoMesh, Field > >	T () const
	Return transpose (only if it is a tensor field) More...

void	relax (const scalar alpha)
	Relax field (for steady-state solution). More...

void	relax ()
	Relax current field with respect to the cached previous iteration. More...

void	relax (const tmp< GeometricField< Type, GeoMesh, PrimitiveField2 >> &, const scalar alpha)
	Relax given field with respect to the current field. More...

void	relax (const tmp< GeometricField< Type, GeoMesh, PrimitiveField2 >> &)
	Relax given field with respect to the current field. More...

scalar	relaxationFactor () const
	Return the field relaxation factor read from fvSolution. More...

word	select (bool final) const
	Select the final iteration parameters if `final' is true. More...

void	writeMinMax (Ostream &os) const
	Helper function to write the min and max to an Ostream. More...

void	negate ()

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

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

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

void	replace (const direction, const GeometricField< scalar, volMesh, PrimitiveField > &sf)

void	replace (const direction, const GeometricField< scalar, volMesh, PrimitiveField > &gsf)

void	replace (const direction d, const GeometricField< typename GeometricField< Type, GeoMesh, PrimitiveField >::cmptType, GeoMesh, PrimitiveField2 > &gcf)

void	replace (const direction d, const tmp< GeometricField< typename GeometricField< Type, GeoMesh, PrimitiveField >::cmptType, GeoMesh, PrimitiveField2 > > &gcf)

void	max (const dimensioned< Type > &)

void	min (const dimensioned< Type > &)

void	maxMin (const dimensioned< Type > &minDt, const dimensioned< Type > &maxDt)

const Internal &	operator() () const
	Return a const-reference to the dimensioned internal field. More...

void	operator= (const GeometricField< Type, GeoMesh, PrimitiveField > &)

void	operator= (GeometricField< Type, GeoMesh, PrimitiveField > &&)

void	operator= (const GeometricField< Type, GeoMesh, PrimitiveField2 > &)

void	operator= (const tmp< GeometricField< Type, GeoMesh, PrimitiveField >> &)

void	operator= (const tmp< GeometricField< Type, GeoMesh, PrimitiveField2 >> &)

void	operator= (const dimensioned< Type > &)

void	operator= (const zero &)

void	operator== (const GeometricField< Type, GeoMesh, PrimitiveField2 > &)

void	operator== (const tmp< GeometricField< Type, GeoMesh, PrimitiveField >> &)

void	operator== (const tmp< GeometricField< Type, GeoMesh, PrimitiveField2 >> &)

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

void	operator== (const zero &)

void	operator+= (const GeometricField< Type, GeoMesh, PrimitiveField2 > &)

void	operator+= (const tmp< GeometricField< Type, GeoMesh, PrimitiveField2 >> &)

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

void	operator-= (const GeometricField< Type, GeoMesh, PrimitiveField2 > &)

void	operator-= (const tmp< GeometricField< Type, GeoMesh, PrimitiveField2 >> &)

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

void	operator*= (const GeometricField< scalar, GeoMesh, PrimitiveField2 > &)

void	operator*= (const tmp< GeometricField< scalar, GeoMesh, PrimitiveField2 >> &)

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

void	operator/= (const GeometricField< scalar, GeoMesh, PrimitiveField2 > &)

void	operator/= (const tmp< GeometricField< scalar, GeoMesh, PrimitiveField2 >> &)

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

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

	DimensionedField (const IOobject &, const Mesh &mesh, const dimensionSet &, const PrimitiveField< Type > &)
	Construct from components. More...

	DimensionedField (const IOobject &, const Mesh &mesh, const dimensionSet &, const bool checkIOFlags=true)
	Construct from components. More...

	DimensionedField (const IOobject &, const Mesh &mesh, const dimensioned< Type > &, const bool checkIOFlags=true)
	Construct from components. More...

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

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

	DimensionedField (const DimensionedField< Type, GeoMesh, PrimitiveField > &)
	Copy constructor. More...

	DimensionedField (DimensionedField< Type, GeoMesh, PrimitiveField > &&)
	Move constructor. More...

template<template< class > class PrimitiveField2>
	DimensionedField (const DimensionedField< Type, GeoMesh, PrimitiveField2 > &)
	Copy constructor. More...

template<template< class > class PrimitiveField2>
	DimensionedField (DimensionedField< Type, GeoMesh, PrimitiveField2 > &, const bool reuse)
	Copy constructor or reuse as specified. More...

	DimensionedField (const tmp< DimensionedField< Type, GeoMesh, PrimitiveField >> &)
	Copy constructor of tmp<DimensionedField> deleting argument. More...

template<template< class > class PrimitiveField2>
	DimensionedField (const IOobject &, const DimensionedField< Type, GeoMesh, PrimitiveField2 > &, const bool checkIOFlags=true)
	Copy constructor resetting IO parameters. More...

template<template< class > class PrimitiveField2>
	DimensionedField (const IOobject &, DimensionedField< Type, GeoMesh, PrimitiveField2 > &, const bool reuse, const bool checkIOFlags=true)
	Copy constructor resetting IO parameters and reuse as specified. More...

	DimensionedField (const IOobject &, const tmp< DimensionedField< Type, GeoMesh, PrimitiveField >> &, const bool checkIOFlags=true)
	Copy constructor from tmp resetting IO parameters. More...

template<template< class > class PrimitiveField2>
	DimensionedField (const word &newName, const DimensionedField< Type, GeoMesh, PrimitiveField2 > &)
	Copy constructor resetting name. More...

template<template< class > class PrimitiveField2>
	DimensionedField (const word &newName, DimensionedField< Type, GeoMesh, PrimitiveField2 > &, const bool reuse)
	Copy constructor resetting name and reuse as specified. More...

	DimensionedField (const word &newName, const tmp< DimensionedField< Type, GeoMesh, PrimitiveField >> &)
	Copy constructor from tmp resetting name. More...

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

virtual	~DimensionedField ()
	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...

PrimitiveField< Type > &	primitiveFieldRef ()
	Return a reference to the internal field. More...

const PrimitiveField< Type > &	primitiveField () const
	Return a const-reference to the primitive field. More...

	USING_OLD_TIME_FIELD (DimensionedField)
	Use old-time methods from the base class. More...

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

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

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

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

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

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

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

template<template< class > class PrimitiveField2>
void	reset (const DimensionedField< Type, GeoMesh, PrimitiveField2 > &)
	Reset the field values to the given field. More...

void	reset (const tmp< DimensionedField< Type, GeoMesh, PrimitiveField >> &)
	Reset the field values to the given tmp-field. More...

template<template< class > class PrimitiveField2>
void	reset (const tmp< DimensionedField< Type, GeoMesh, PrimitiveField2 >> &)
	Reset the field values to the given tmp-field. More...

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

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

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

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

template<template< class > class PrimitiveField2>
void	operator= (const DimensionedField< Type, GeoMesh, PrimitiveField2 > &)

template<template< class > class PrimitiveField2>
void	operator= (const tmp< DimensionedField< Type, GeoMesh, PrimitiveField2 >> &)

void	operator= (const dimensioned< Type > &)

void	operator= (const zero &)

template<template< class > class PrimitiveField2>
void	operator== (const DimensionedField< Type, GeoMesh, PrimitiveField2 > &)

template<template< class > class PrimitiveField2>
void	operator== (const tmp< DimensionedField< Type, GeoMesh, PrimitiveField2 >> &)

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

void	operator== (const zero &)

template<template< class > class PrimitiveField2>
void	operator+= (const DimensionedField< Type, GeoMesh, PrimitiveField2 > &)

template<template< class > class PrimitiveField2>
void	operator+= (const tmp< DimensionedField< Type, GeoMesh, PrimitiveField2 >> &)

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

template<template< class > class PrimitiveField2>
void	operator-= (const DimensionedField< Type, GeoMesh, PrimitiveField2 > &)

template<template< class > class PrimitiveField2>
void	operator-= (const tmp< DimensionedField< Type, GeoMesh, PrimitiveField2 >> &)

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

template<template< class > class PrimitiveField2>
void	operator*= (const DimensionedField< scalar, GeoMesh, PrimitiveField2 > &)

template<template< class > class PrimitiveField2>
void	operator*= (const tmp< DimensionedField< scalar, GeoMesh, PrimitiveField2 >> &)

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

template<template< class > class PrimitiveField2>
void	operator/= (const DimensionedField< scalar, GeoMesh, PrimitiveField2 > &)

template<template< class > class PrimitiveField2>
void	operator/= (const tmp< DimensionedField< scalar, GeoMesh, PrimitiveField2 >> &)

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

template<template< class > class PrimitiveField2>
Foam::tmp< Foam::DimensionedField< Type, GeoMesh, PrimitiveField > >	New (const word &newName, const DimensionedField< Type, GeoMesh, PrimitiveField2 > &df)

template<template< class > class PrimitiveField2>
void	replace (const direction d, const DimensionedField< typename DimensionedField< Type, GeoMesh, PrimitiveField >::cmptType, GeoMesh, PrimitiveField2 > &df)

template<template< class > class PrimitiveField2>
void	replace (const direction d, const tmp< DimensionedField< typename DimensionedField< Type, GeoMesh, PrimitiveField >::cmptType, GeoMesh, PrimitiveField2 > > &tdf)

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 &)
	Copy constructor. More...

	regIOobject (regIOobject &&)
	Move constructor. More...

	regIOobject (const regIOobject &, bool registerCopy)
	Copy constructor, transferring registry registration to copy. More...

	regIOobject (const word &newName, const regIOobject &, bool registerCopy)
	Copy constructor with new name, transferring registry registration. More...

	regIOobject (const IOobject &, const regIOobject &)
	Copy constructor with new IO parameters. More...

virtual	~regIOobject ()
	Destructor. More...

virtual bool	global () const
	Return true if object is global, i.e. same for all processors. More...

virtual bool	globalFile () const
	Return true if object is global, i.e. same for all processors. More...

const fileName &	caseName () const

fileName	path () const
	Return complete path. More...

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

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

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

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

void	addWatch ()
	Add file watch on object (if registered and READ_IF_MODIFIED) More...

bool	registered () const
	Is this object registered with the 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...

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

Istream &	readStream (const word &, const bool read=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...

const labelList &	watchIndices () const
	Return file-monitoring handles. More...

labelList &	watchIndices ()
	Return file-monitoring handles. More...

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

virtual bool	dependenciesModified () const
	Return true if the object's dependencies have been modified. More...

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

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

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

void	operator= (const IOobject &)=delete
	Assign to IOobject. More...

void	operator= (const regIOobject &)=delete
	Disallow default assignment. More...

const fileName &	caseName (const bool global) const

fileName	path (const bool global) const
	Return complete path including the processor sub-directory. More...

fileName	objectPath (const bool global) const
	Return complete path + object name including the processor. More...

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

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 objectRegistry &registry)
	Construct from copy resetting registry. More...

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

	IOobject (const IOobject &io)=default
	Copy constructor. More...

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

autoPtr< IOobject >	clone (const objectRegistry &registry) const
	Clone resetting registry. 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...

word &	headerClassName ()
	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 bool global) const

fileName &	instance () const
	Return the instance directory, constant, system, <time> etc. More...

void	updateInstance () const
	If the instance is a time directory update to the current time. More...

void	updateTimeInstance () const
	Update instance to the current time. More...

const fileName &	local () const

fileName	path (const bool global) const
	Return complete path including the processor sub-directory. More...

fileName	objectPath (const bool global) const
	Return complete path + object name including the processor. More...

fileName	relativePath () const
	Return the path relative to the case directory. More...

fileName	relativeObjectPath () const
	Return complete relativePath + object name. More...

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

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

bool	headerOk ()
	Read header of local object without type-checking. More...

template<class Type >
void	warnNoRereading () const
	Helper: warn that type does not support re-reading. 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 OldTimeField< DimensionedField< Type, GeoMesh, PrimitiveField > >
	OldTimeField (const label timeIndex)
	Construct from a time index. More...

	OldTimeField (const OldTimeField< DimensionedField< Type, GeoMesh, PrimitiveField > > &otf)
	Copy construct. More...

	OldTimeField (OldTimeField< DimensionedField< Type, GeoMesh, PrimitiveField > > &&otf)
	Move construct. More...

	~OldTimeField ()
	Destructor. More...

label	timeIndex () const
	Return the time index of the field. More...

label &	timeIndex ()
	Return a non-const reference to the time index of the field. More...

bool	isOldTime () const
	Return whether or not this is an old-time field. More...

bool	hasStoredOldTimes () const
	Return whether old-time fields have been stored yet. More...

void	storeOldTimes () const
	Store the old-time fields. More...

void	clearOldTimes ()
	Clear old-time fields. More...

void	nullOldestTime ()
	Set the oldest field pointer to nullObjectPtr. This removes the. More...

label	nOldTimes (const bool includeNull=true) const
	Return the number of old-time fields stored. More...

const Field0Type &	oldTime () const
	Return the old-time field. More...

const Field0Type &	oldTime (const label n) const
	Return the n-th old-time field. More...

Field0Type &	oldTimeRef ()
	Return a non-const reference to the old-time field. More...

Field0Type &	oldTimeRef (const label n)
	Return a non-const reference to the n-th old time field. More...

void	operator= (const OldTimeField< DimensionedField< Type, GeoMesh, PrimitiveField > > &)=delete
	Disallow default bitwise assignment. More...

Public Member Functions inherited from OldTimeField< GeometricField< Type, GeoMesh, PrimitiveField > >
	OldTimeField (const label timeIndex)
	Construct from a time index. More...

	OldTimeField (const OldTimeField< GeometricField< Type, GeoMesh, PrimitiveField > > &otf)
	Copy construct. More...

	OldTimeField (OldTimeField< GeometricField< Type, GeoMesh, PrimitiveField > > &&otf)
	Move construct. More...

	~OldTimeField ()
	Destructor. More...

label	timeIndex () const
	Return the time index of the field. More...

label &	timeIndex ()
	Return a non-const reference to the time index of the field. More...

bool	isOldTime () const
	Return whether or not this is an old-time field. More...

bool	hasStoredOldTimes () const
	Return whether old-time fields have been stored yet. More...

void	storeOldTimes () const
	Store the old-time fields. More...

void	clearOldTimes ()
	Clear old-time fields. More...

void	nullOldestTime ()
	Set the oldest field pointer to nullObjectPtr. This removes the. More...

label	nOldTimes (const bool includeNull=true) const
	Return the number of old-time fields stored. More...

const Field0Type &	oldTime () const
	Return the old-time field. More...

const Field0Type &	oldTime (const label n) const
	Return the n-th old-time field. More...

Field0Type &	oldTimeRef ()
	Return a non-const reference to the old-time field. More...

Field0Type &	oldTimeRef (const label n)
	Return a non-const reference to the n-th old time field. More...

void	operator= (const OldTimeField< GeometricField< Type, GeoMesh, PrimitiveField > > &)=delete
	Disallow default bitwise assignment. More...

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

static tmp< GeometricField< Type, GeoMesh, PrimitiveField > >	New (const word &name, const Internal &, const PtrList< Patch > &, const HashPtrTable< Source > &=HashPtrTable< Source >())
	Return a temporary field constructed from name,. More...

static tmp< GeometricField< Type, GeoMesh, PrimitiveField > >	New (const word &name, const Mesh &, const dimensionSet &, const word &patchFieldType=Patch::calculatedType())
	Return a temporary field constructed from name, mesh, dimensionSet. More...

static tmp< GeometricField< Type, GeoMesh, PrimitiveField > >	New (const word &name, const Mesh &, const dimensioned< Type > &, const word &patchFieldType=Patch::calculatedType())
	Return a temporary field constructed from mesh, dimensioned<Type> More...

static tmp< GeometricField< Type, GeoMesh, PrimitiveField > >	New (const word &name, const Mesh &, const dimensioned< Type > &, const wordList &patchFieldTypes, const wordList &actualPatchTypes=wordList(), const HashTable< word > &fieldSourceTypes=HashTable< word >())
	Return a temporary field constructed from mesh, dimensioned<Type> More...

static tmp< GeometricField< Type, GeoMesh, PrimitiveField > >	New (const word &newName, const tmp< GeometricField< Type, GeoMesh, PrimitiveField >> &)
	Rename temporary field and return. More...

static tmp< GeometricField< Type, GeoMesh, PrimitiveField > >	New (const word &newName, const GeometricField< Type, GeoMesh, PrimitiveField2 > &, const word &patchFieldType)
	Rename field, reset patch field type and return. More...

static tmp< GeometricField< Type, GeoMesh, PrimitiveField > >	New (const word &newName, const tmp< GeometricField< Type, GeoMesh, PrimitiveField >> &, const word &patchFieldType)
	Rename temporary field, reset patch field type and return. More...

static tmp< GeometricField< Type, GeoMesh, PrimitiveField > >	New (const word &name, const DimensionedField< Type, GeoMesh, PrimitiveField2 > &, const word &patchFieldType)
	Return a temporary field constructed from name,. More...

static tmp< GeometricField< Type, GeoMesh, PrimitiveField > >	New (const word &name, const tmp< Internal > &, const word &patchFieldType)
	Return a temporary field constructed from name,. More...

static tmp< GeometricField< Type, GeoMesh, PrimitiveField > >	New (const word &newName, const GeometricField< Type, GeoMesh, PrimitiveField2 > &, const wordList &patchFieldTypes, const wordList &actualPatchTypes=wordList(), const HashTable< word > &fieldSourceTypes=HashTable< word >())
	Rename and reset patch fields types of field and return. More...

static tmp< GeometricField< Type, GeoMesh, PrimitiveField > >	New (const word &newName, const tmp< GeometricField< Type, GeoMesh, PrimitiveField >> &, const wordList &patchFieldTypes, const wordList &actualPatchTypes=wordList(), const HashTable< word > &fieldSourceTypes=HashTable< word >())
	Rename and reset patch fields types of temporary field and return. More...

static tmp< GeometricField< Type, GeoMesh, PrimitiveField > >	New (const word &newName, const DimensionedField< Type, GeoMesh, PrimitiveField2 > &, const wordList &patchFieldTypes, const wordList &actualPatchTypes=wordList(), const HashTable< word > &fieldSourceTypes=HashTable< word >())
	Return a temporary field constructed from IOobject,. More...

static tmp< GeometricField< Type, GeoMesh, PrimitiveField > >	New (const word &newName, const tmp< Internal > &, const wordList &patchFieldTypes, const wordList &actualPatchTypes=wordList(), const HashTable< word > &fieldSourceTypes=HashTable< word >())
	Return a temporary field constructed from IOobject,. More...

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

static tmp< DimensionedField< Type, GeoMesh, PrimitiveField > >	New (const word &name, const Mesh &mesh, const dimensionSet &, const PrimitiveField< Type > &)
	Return a temporary field constructed from name, mesh,. More...

static tmp< DimensionedField< Type, GeoMesh, PrimitiveField > >	New (const word &name, const Mesh &mesh, const dimensionSet &)
	Return a temporary field constructed from name, mesh. More...

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

template<template< class > class PrimitiveField2>
static tmp< DimensionedField< Type, GeoMesh, PrimitiveField > >	New (const word &newName, const DimensionedField< Type, GeoMesh, PrimitiveField2 > &)
	Return a temporary field constructed from name and a field. More...

static tmp< DimensionedField< Type, GeoMesh, PrimitiveField > >	New (const word &newName, const tmp< DimensionedField< Type, GeoMesh, PrimitiveField >> &)
	Return renamed temporary field. 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)

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 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 Public Attributes inherited from regIOobject
static float	fileModificationSkew

Static Public Attributes inherited from IOobject
static constexpr const char *	foamFile = "FoamFile"
	Keyword for the FoamFile header sub-dictionary. More...

static const NamedEnum< fileCheckTypes, 4 >	fileCheckTypesNames

static fileCheckTypes	fileModificationChecking
	Type of file modification checking. More...

Protected Member Functions inherited from regIOobject
bool	readHeaderOk (const IOstream::streamFormat defaultFormat, const word &typeName)
	Read header, check readOpt flags and read data if necessary. More...

Protected Member Functions inherited from IOobject
template<class Type >
bool	typeHeaderOk (const bool checkType)
	Read header using typeGlobalFile to find file. More...

Protected Member Functions inherited from OldTimeField< DimensionedField< Type, GeoMesh, PrimitiveField > >
bool	readOldTimeIfPresent ()
	Read old-time field from file if it is present. More...

void	copyOldTimes (const IOobject &io, const OtherOldTime< OtherPrimitiveField > &)
	Copy the old-times from the given field. More...

void	copyOldTimes (const word &newName, const OtherOldTime< OtherPrimitiveField > &)
	Copy the old-times from the given field. More...

Protected Member Functions inherited from OldTimeField< GeometricField< Type, GeoMesh, PrimitiveField > >
bool	readOldTimeIfPresent ()
	Read old-time field from file if it is present. More...

void	copyOldTimes (const IOobject &io, const OtherOldTime< OtherPrimitiveField > &)
	Copy the old-times from the given field. More...

void	copyOldTimes (const word &newName, const OtherOldTime< OtherPrimitiveField > &)
	Copy the old-times from the given field. More...

Detailed Description

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

Specialisation of GeometricField which holds slices of given complete fields in a form that they act as a GeometricField.

The destructor is wrapped to avoid deallocation of the storage of the complete fields when this is destroyed.

SlicedGeometricField can only be instantiated with a valid form of SlicedPatchField to handle the slicing and storage deallocation of the boundary field.

Source files

Definition at line 58 of file SlicedGeometricField.H.

Member Typedef Documentation

◆ Mesh

typedef GeoMesh::Mesh Mesh

Type of mesh on which this SlicedGeometricField is instantiated.

Definition at line 67 of file SlicedGeometricField.H.

◆ Internal

typedef SlicedDimensionedField<Type, GeoMesh> Internal

Type of the internal field from which this SlicedGeometricField is.

derived

Definition at line 71 of file SlicedGeometricField.H.

◆ Patch

typedef GeoMesh::template PatchField<Type> Patch

Type of the patch field of which the Boundary is composed.

Definition at line 74 of file SlicedGeometricField.H.

◆ SlicedPatch

typedef Patch::Sliced SlicedPatch

Type of the sliced patch field of which the Boundary is composed.

Definition at line 77 of file SlicedGeometricField.H.

Constructor & Destructor Documentation

◆ SlicedGeometricField() [1/4]

SlicedGeometricField	(	const IOobject &	io,
		const Mesh &	mesh,
		const dimensionSet &	ds,
		const Field< Type > &	completeField,
		const bool	preserveCouples = `true`
	)

Construct from components and field to slice.

Definition at line 164 of file SlicedGeometricField.C.

References SlicedGeometricField< Type, GeoMesh >::correctBoundaryConditions(), DimensionedField< Type, GeoMesh, PrimitiveField >::mesh(), and UList< T >::shallowCopy().

Here is the call graph for this function:

◆ SlicedGeometricField() [2/4]

SlicedGeometricField	(	const IOobject &	io,
		const Mesh &	mesh,
		const dimensionSet &	ds,
		const Field< Type > &	completeIField,
		const Field< Type > &	completeBField,
		const bool	preserveCouples = `true`,
		const bool	preserveProcessorOnly = `false`
	)