Inheritance diagram for GeometricField< Type, GeoMesh, PrimitiveField >:

[legend]

Collaboration diagram for GeometricField< Type, GeoMesh, PrimitiveField >:

Public Types
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
	TypeName ("GeometricField")
	Runtime type information. More...

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

template<template< class > class PrimitiveField2>
	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...

template<template< class > class PrimitiveField2>
	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...

template<template< class > class PrimitiveField2>
	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...

template<template< class > class PrimitiveField2>
	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...

template<template< class > class PrimitiveField2>
	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...

template<template< class > class PrimitiveField2>
	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...

template<template< class > class PrimitiveField2>
	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...

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

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

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

template<template< class > class PrimitiveField2>
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...

template<template< class > class PrimitiveField2>
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...

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

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

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

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

template<template< class > class PrimitiveField2>
void	relax (const tmp< GeometricField< Type, GeoMesh, PrimitiveField2 >> &)
	Relax given field with respect to the current field. 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 ()

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

template<template< class > class PrimitiveField2>
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	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 > &&)

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

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

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

void	operator= (const dimensioned< Type > &)

void	operator= (const zero &)

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

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

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

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

void	operator== (const zero &)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

template<template< class > class PrimitiveField2>
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)

template<template< class > class PrimitiveField2>
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)

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

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

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

Static Public Member Functions
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...

template<template< class > class PrimitiveField2>
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...

template<template< class > class PrimitiveField2>
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...

template<template< class > class PrimitiveField2>
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...

template<template< class > class PrimitiveField2>
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...

Friends
template<class Type2 , class GeoMesh2 , template< class > class PrimitiveField2>
class	GeometricField
	Declare friendship with other geometric fields. More...

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

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

Additional Inherited Members
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, template< class > class PrimitiveField>
class Foam::GeometricField< Type, GeoMesh, PrimitiveField >

Generic GeometricField class.

Source files

Definition at line 73 of file GeometricField.H.

Member Typedef Documentation

◆ Mesh

typedef GeoMesh::Mesh Mesh

Type of mesh on which this GeometricField is instantiated.

Definition at line 89 of file GeometricField.H.

◆ Internal

typedef DimensionedField<Type, GeoMesh, PrimitiveField> Internal

Type of the internal field from which this GeometricField is derived.

Definition at line 92 of file GeometricField.H.

◆ Base

typedef DimensionedField<Type, GeoMesh, PrimitiveField> Base

Type of the field from which this GeometricField is derived.

Definition at line 95 of file GeometricField.H.

◆ Patch

typedef GeoMesh::template PatchField<Type> Patch

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

Definition at line 98 of file GeometricField.H.

◆ Boundary

typedef GeometricBoundaryField<Type, GeoMesh, PrimitiveField> Boundary

Type of the boundary field.

Definition at line 101 of file GeometricField.H.

◆ Source

typedef GeoMesh::template FieldSource<Type> Source

Type of the field source of which the Sources is composed.

Definition at line 104 of file GeometricField.H.

◆ Sources

typedef GeometricFieldSources<Type, GeoMesh, PrimitiveField> Sources

Type of the field sources.

Definition at line 107 of file GeometricField.H.

◆ cmptType

typedef Field<Type>::cmptType cmptType

Component type of the elements of the field.

Definition at line 110 of file GeometricField.H.

Constructor & Destructor Documentation

◆ GeometricField() [1/24]

GeometricField	(	const IOobject &	io,
		const Mesh &	mesh,
		const dimensionSet &	ds,
		const word &	patchFieldType = `Patch::calculatedType()`
	)

Constructor given IOobject, mesh, dimensions and patch field type.

This allocates storage for the field but not values. Used only within this class to create TEMPORARY variables

Definition at line 166 of file GeometricField.C.

◆ GeometricField() [2/24]

GeometricField	(	const IOobject &	io,
		const Mesh &	mesh,
		const dimensionSet &	ds,
		const wordList &	wantedPatchTypes,
		const wordList &	actualPatchTypes = `wordList()`,
		const HashTable< word > &	fieldSourceTypes = `HashTable<word>()`
	)

Constructor given IOobject, mesh, dimensions and patch field types.

This allocates storage for the field but not values. Used only within this class to create TEMPORARY variables

Definition at line 190 of file GeometricField.C.

◆ GeometricField() [3/24]

GeometricField	(	const IOobject &	io,
		const Mesh &	mesh,
		const dimensioned< Type > &	dt,
		const word &	patchFieldType = `Patch::calculatedType()`
	)

Constructor given IOobject, mesh, dimensioned<Type>

and patch field type.

Definition at line 216 of file GeometricField.C.

◆ GeometricField() [4/24]

GeometricField	(	const IOobject &	io,
		const Mesh &	mesh,
		const dimensioned< Type > &	dt,
		const wordList &	wantedPatchTypes,
		const wordList &	actualPatchTypes = `wordList()`,
		const HashTable< word > &	fieldSourceTypes = `HashTable<word>()`
	)

Constructor given IOobject, mesh, dimensioned<Type>

and patch field types.

Definition at line 242 of file GeometricField.C.

◆ GeometricField() [5/24]

GeometricField	(	const IOobject &	io,
		const Internal &	diField,
		const PtrList< Patch > &	ptfl,
		const HashPtrTable< Source > &	stft = `HashPtrTable<Source>()`
	)

Constructor from components.

Definition at line 270 of file GeometricField.C.

◆ GeometricField() [6/24]

GeometricField	(	const IOobject &	io,
		const Mesh &	mesh,
		const dimensionSet &	ds,
		const PrimitiveField< Type > &	iField,
		const PtrList< Patch > &	ptfl,
		const HashPtrTable< Source > &	stft = `HashPtrTable<Source>()`
	)

Constructor from components.

Definition at line 295 of file GeometricField.C.

◆ GeometricField() [7/24]

GeometricField	(	const IOobject &	io,
		const Mesh &	mesh
	)

Construct and read given IOobject.

Definition at line 320 of file GeometricField.C.

◆ GeometricField() [8/24]

GeometricField	(	const IOobject &	io,
		const Mesh &	mesh,
		const dictionary &	dict
	)

Construct from dictionary.

Definition at line 355 of file GeometricField.C.

◆ GeometricField() [9/24]

GeometricField ( const GeometricField< Type, GeoMesh, PrimitiveField > & gf )

Copy constructor.

Definition at line 390 of file GeometricField.C.

◆ GeometricField() [10/24]

GeometricField ( const GeometricField< Type, GeoMesh, PrimitiveField2 > & gf )

explicit

Copy constructor.

Definition at line 413 of file GeometricField.C.

◆ GeometricField() [11/24]

GeometricField ( GeometricField< Type, GeoMesh, PrimitiveField > && gf )

Move constructor.

Definition at line 435 of file GeometricField.C.

◆ GeometricField() [12/24]

GeometricField ( const tmp< GeometricField< Type, GeoMesh, PrimitiveField >> & tgf )

Construct as copy of tmp.

Definition at line 457 of file GeometricField.C.

◆ GeometricField() [13/24]

GeometricField	(	const IOobject &	io,
		const GeometricField< Type, GeoMesh, PrimitiveField2 > &	gf
	)

Construct as copy resetting IO parameters.

Definition at line 486 of file GeometricField.C.

◆ GeometricField() [14/24]

GeometricField	(	const IOobject &	io,
		const tmp< GeometricField< Type, GeoMesh, PrimitiveField >> &	tgf
	)

Construct as copy of tmp resetting IO parameters.

Definition at line 513 of file GeometricField.C.

◆ GeometricField() [15/24]

GeometricField	(	const word &	newName,
		const GeometricField< Type, GeoMesh, PrimitiveField2 > &	gf
	)

Construct as copy resetting name.

Definition at line 546 of file GeometricField.C.

◆ GeometricField() [16/24]

GeometricField	(	const word &	newName,
		const tmp< GeometricField< Type, GeoMesh, PrimitiveField >> &	tgf
	)

Construct as copy of tmp resetting name.

Definition at line 570 of file GeometricField.C.

◆ GeometricField() [17/24]

GeometricField	(	const IOobject &	io,
		const GeometricField< Type, GeoMesh, PrimitiveField2 > &	gf,
		const word &	patchFieldType
	)

Construct as copy resetting IO parameters and patch field type.

Definition at line 600 of file GeometricField.C.

◆ GeometricField() [18/24]

GeometricField	(	const IOobject &	io,
		const tmp< GeometricField< Type, GeoMesh, PrimitiveField >> &	tgf,
		const word &	patchFieldType
	)

Construct as copy of tmp resetting IO parameters.

and patch field type

Definition at line 630 of file GeometricField.C.

◆ GeometricField() [19/24]

GeometricField	(	const IOobject &	io,
		const DimensionedField< Type, GeoMesh, PrimitiveField2 > &	df,
		const word &	patchFieldType
	)

Constructor from internal field and patch field type.

Definition at line 666 of file GeometricField.C.

◆ GeometricField() [20/24]

GeometricField	(	const IOobject &	io,
		const tmp< Internal > &	tdf,
		const word &	patchFieldType
	)

Constructor from temporary internal field and patch field type.

Definition at line 693 of file GeometricField.C.

◆ GeometricField() [21/24]

GeometricField	(	const IOobject &	io,
		const GeometricField< Type, GeoMesh, PrimitiveField2 > &	gf,
		const wordList &	patchFieldTypes,
		const wordList &	actualPatchTypes = `wordList()`,
		const HashTable< word > &	fieldSourceTypes = `HashTable<word>()`
	)

Construct as copy resetting IO parameters and patch field types.

Definition at line 721 of file GeometricField.C.

◆ GeometricField() [22/24]

GeometricField	(	const IOobject &	io,
		const tmp< GeometricField< Type, GeoMesh, PrimitiveField >> &	tgf,
		const wordList &	patchFieldTypes,
		const wordList &	actualPatchTypes = `wordList()`,
		const HashTable< word > &	fieldSourceTypes = `HashTable<word>()`
	)

Construct as copy of tmp resetting IO parameters.

and patch field types

Definition at line 759 of file GeometricField.C.

References PtrList< T >::clear(), Foam::endl(), IOobject::info(), and InfoInFunction.

Here is the call graph for this function:

◆ GeometricField() [23/24]

GeometricField	(	const IOobject &	io,
		const DimensionedField< Type, GeoMesh, PrimitiveField2 > &	df,
		const wordList &	patchFieldTypes,
		const wordList &	actualPatchTypes = `wordList()`,
		const HashTable< word > &	fieldSourceTypes = `HashTable<word>()`
	)

Construct from IOobject, internal field and patch field types.

Definition at line 803 of file GeometricField.C.

References Foam::endl(), IOobject::info(), and InfoInFunction.

Here is the call graph for this function:

◆ GeometricField() [24/24]

GeometricField	(	const IOobject &	io,
		const tmp< Internal > &	tdf,
		const wordList &	patchFieldTypes,
		const wordList &	actualPatchTypes = `wordList()`,
		const HashTable< word > &	fieldSourceTypes = `HashTable<word>()`
	)

Construct from IOobject, tmp internal field and patch field types.

Definition at line 836 of file GeometricField.C.

References tmp< T >::clear(), Foam::endl(), IOobject::info(), and InfoInFunction.

Here is the call graph for this function:

◆ ~GeometricField()

~GeometricField

virtual

Destructor.

Definition at line 1364 of file GeometricField.C.

Member Function Documentation

◆ TypeName()

TypeName ( "GeometricField< Type, GeoMesh, PrimitiveField >" )

Runtime type information.

◆ null()

const Foam::GeometricField< Type, GeoMesh, PrimitiveField > & null

inlinestatic

Return a null geometric field.

Definition at line 32 of file GeometricFieldI.H.

Here is the caller graph for this function:

◆ clone()

Foam::tmp< Foam::GeometricField< Type, GeoMesh, PrimitiveField > > clone

Clone.

Definition at line 872 of file GeometricField.C.

Referenced by ParticleTracks< CloudType >::preFace().

Here is the caller graph for this function:

◆ cloneUnSliced()

Foam::tmp< Foam::GeometricField< Type, GeoMesh, PrimitiveField > > cloneUnSliced

Clone un-sliced.

Definition at line 883 of file GeometricField.C.

References mesh, Foam::name(), IOobject::NO_READ, and IOobject::NO_WRITE.

Here is the call graph for this function:

◆ New() [1/17]

Foam::tmp< Foam::GeometricField< Type, GeoMesh, PrimitiveField > > New	(	const word &	name,
		const Internal &	diField,
		const PtrList< Patch > &	ptfl,
		const HashPtrTable< Source > &	stft = `HashPtrTable<Source>()`
	)

static

Return a temporary field constructed from name,.

internal field and list of patch fields

Definition at line 907 of file GeometricField.C.

References DimensionedField< Type, GeoMesh, PrimitiveField >::mesh(), Foam::name(), IOobject::NO_READ, and IOobject::NO_WRITE.

Here is the call graph for this function:

◆ New() [2/17]

Foam::tmp< Foam::GeometricField< Type, GeoMesh, PrimitiveField > > New	(	const word &	name,
		const Mesh &	mesh,
		const dimensionSet &	ds,
		const word &	patchFieldType = `Patch::calculatedType()`
	)

static

Return a temporary field constructed from name, mesh, dimensionSet.

and patch field type

Definition at line 941 of file GeometricField.C.

References objectRegistry::cacheTemporaryObject(), mesh, dimensioned< Type >::name(), Foam::name(), IOobject::NO_READ, IOobject::NO_WRITE, Foam::patchFieldType(), fvMesh::thisDb(), and objectRegistry::time().

Here is the call graph for this function:

◆ New() [3/17]

Foam::tmp< Foam::GeometricField< Type, GeoMesh, PrimitiveField > > New	(	const word &	name,
		const Mesh &	mesh,
		const dimensioned< Type > &	dt,
		const word &	patchFieldType = `Patch::calculatedType()`
	)

static

Return a temporary field constructed from mesh, dimensioned<Type>

and patch field type

Definition at line 975 of file GeometricField.C.

References objectRegistry::cacheTemporaryObject(), mesh, dimensioned< Type >::name(), Foam::name(), IOobject::NO_READ, IOobject::NO_WRITE, Foam::patchFieldType(), fvMesh::thisDb(), and objectRegistry::time().

Here is the call graph for this function:

◆ New() [4/17]

Foam::tmp< Foam::GeometricField< Type, GeoMesh, PrimitiveField > > New	(	const word &	name,
		const Mesh &	mesh,
		const dimensioned< Type > &	dt,
		const wordList &	patchFieldTypes,
		const wordList &	actualPatchTypes = `wordList()`,
		const HashTable< word > &	fieldSourceTypes = `HashTable<word>()`
	)

static

Return a temporary field constructed from mesh, dimensioned<Type>

and patch field types

Definition at line 1010 of file GeometricField.C.

References objectRegistry::cacheTemporaryObject(), mesh, dimensioned< Type >::name(), Foam::name(), IOobject::NO_READ, IOobject::NO_WRITE, fvMesh::thisDb(), and objectRegistry::time().

Here is the call graph for this function:

◆ New() [5/17]

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

static

Rename temporary field and return.

Definition at line 1048 of file GeometricField.C.

References IOobject::NO_READ, and IOobject::NO_WRITE.

◆ New() [6/17]

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

static

Rename field, reset patch field type and return.

◆ New() [7/17]

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

static

Rename temporary field, reset patch field type and return.

Definition at line 1113 of file GeometricField.C.

References IOobject::NO_READ, IOobject::NO_WRITE, and Foam::patchFieldType().

Here is the call graph for this function:

◆ New() [8/17]

static tmp<GeometricField<Type, GeoMesh, PrimitiveField> > New	(	const word &	name,
		const DimensionedField< Type, GeoMesh, PrimitiveField2 > &	,
		const word &	patchFieldType
	)

static

Return a temporary field constructed from name,.

internal field and patch field type

◆ New() [9/17]

Foam::tmp< Foam::GeometricField< Type, GeoMesh, PrimitiveField > > New	(	const word &	name,
		const tmp< Internal > &	tdf,
		const word &	patchFieldType
	)

static

Return a temporary field constructed from name,.

temporary internal field and patch field type

Definition at line 1180 of file GeometricField.C.

References IOobject::NO_READ, IOobject::NO_WRITE, and Foam::patchFieldType().

Here is the call graph for this function:

◆ New() [10/17]

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 >()`
	)

static

Rename and reset patch fields types of field and return.

◆ New() [11/17]

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

static

Rename and reset patch fields types of temporary field and return.

Definition at line 1251 of file GeometricField.C.

References IOobject::NO_READ, and IOobject::NO_WRITE.

◆ New() [12/17]

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 >()`
	)

static

Return a temporary field constructed from IOobject,.

internal field and patch field types

◆ New() [13/17]

Foam::tmp< Foam::GeometricField< Type, GeoMesh, PrimitiveField > > New	(	const word &	newName,
		const tmp< Internal > &	tdf,
		const wordList &	patchFieldTypes,
		const wordList &	actualPatchTypes = `wordList()`,
		const HashTable< word > &	fieldSourceTypes = `HashTable<word>()`
	)

static

Return a temporary field constructed from IOobject,.

temporary internal field and patch field types

Definition at line 1326 of file GeometricField.C.

References IOobject::NO_READ, and IOobject::NO_WRITE.

◆ internalFieldRef()

Foam::GeometricField< Type, GeoMesh, PrimitiveField >::Internal & internalFieldRef

Return a reference to the dimensioned internal field.

Note: this increments the event counter and checks the old-time fields; avoid in loops.

Definition at line 1376 of file GeometricField.C.

Referenced by phaseSystem::correctContinuityError(), SpalartAllmarasDES< BasicMomentumTransportModel >::k(), laplaceFilter::laplaceFilter(), Foam::MapGeometricFields(), shockFluid::pressureCorrector(), multiphaseVoFSolver::setInterfaceRDeltaT(), twoPhaseVoFSolver::setInterfaceRDeltaT(), incompressibleFluid::setRDeltaT(), and writeCellVolumes::write().

Here is the caller graph for this function:

◆ internalField()

const Foam::GeometricField< Type, GeoMesh, PrimitiveField >::Internal & internalField

inline

Return a const-reference to the dimensioned internal field.

Definition at line 41 of file GeometricFieldI.H.

Referenced by fvMeshSubset::interpolate(), GeometricField< Type, GeoMesh, PrimitiveField >::operator=(), GeometricField< Type, GeoMesh, PrimitiveField >::operator==(), and fvMeshToFvMesh::srcToTgt().

Here is the caller graph for this function:

◆ v()

const Foam::GeometricField< Type, GeoMesh, PrimitiveField >::Internal & v

inline

Return a const-reference to the dimensioned internal field.

of a "vol" field. Useful in the formulation of source-terms for FV equations

Definition at line 29 of file volFieldsI.H.

Referenced by kOmega2006< BasicMomentumTransportModel >::correct(), realizableKE< BasicMomentumTransportModel >::correct(), phaseSystem::solve(), and fvMeshToFvMesh::srcToTgt().

Here is the caller graph for this function:

◆ primitiveFieldRef()

Foam::GeometricField< Type, GeoMesh, PrimitiveField >::Internal::FieldType & primitiveFieldRef

Return a reference to the primitive field.

Note: this increments the event counter and checks the old-time fields; avoid in loops.

Definition at line 1387 of file GeometricField.C.

Referenced by MRFZone::addCentrifugalAcceleration(), MRFZone::addCoriolis(), anisotropicFilter::anisotropicFilter(), Foam::atan2(), Foam::fvc::average(), cellCoBlended< Type >::blendingFactor(), Foam::bound(), Implicit< CloudType >::cacheFields(), faceLimitedGrad< Type >::calcGrad(), multiValveEngine::movingObject::calcScale(), XiEqModel::calculateSchelkinEffect(), pointConstraints::constrain(), pointConstraints::constrainDisplacement(), wideBand::correct(), Foam::saturationModels::evaluate(), Foam::evaluate(), fvMatrix< Type >::flux(), fvMatrix< Type >::H(), fvMatrix< Type >::H1(), Foam::levelSetFraction(), PhiScheme< Type, PhiLimiter >::limiter(), Foam::mag(), Foam::magSqr(), fvMesh::movePoints(), inverseVolumeDiffusivity::operator()(), Foam::pow(), setCellFieldType(), sixDoFRigidBodyMotionSolver::sixDoFRigidBodyMotionSolver(), Foam::stabilise(), Foam::fvc::surfaceIntegrateExtrapolate(), ReactingCloud< CloudType >::SYi(), Foam::T(), Foam::transform(), MomentumCloud< CloudType >::vDotSweep(), clippedLinear< Type >::weights(), reverseLinear< Type >::weights(), limitedSurfaceInterpolationScheme< Type >::weights(), basicSubGrid::XiEq(), SCOPEXiEq::XiEq(), and MRFZone::zero().

Here is the caller graph for this function:

◆ primitiveField()

const Foam::GeometricField< Type, GeoMesh, PrimitiveField >::Internal::FieldType & primitiveField

inline

Return a const-reference to the primitive field.

Definition at line 50 of file GeometricFieldI.H.

Referenced by Foam::atan2(), cellMDLimitedGrad< Type >::calcGrad(), faceLimitedGrad< Type >::calcGrad(), multiValveEngine::movingObject::calcScale(), Foam::cmptAv(), Foam::component(), function2::correct(), motionSmootherAlgo::curPoints(), pointFieldDecomposer::decomposeField(), fvFieldDecomposer::decomposeFvSurfaceField(), fvFieldDecomposer::decomposeVolField(), faceAreaPairGAMGAgglomeration::faceAreaPairGAMGAgglomeration(), CoEulerDdtScheme< Type >::fvcDdt(), SLTSDdtScheme< Type >::fvcDdt(), ddtScheme< Type >::fvcDdtPhiCoeff(), gaussConvectionScheme< Type >::fvmDiv(), gaussLaplacianScheme< Type, GType >::fvmLaplacianUncorrected(), fvMeshSubset::interpolate(), sampledIsoSurfaceSurface::interpolateField(), Kmesh::Kmesh(), Foam::levelSetFraction(), Foam::mag(), Foam::magSqr(), main(), GeometricField< Type, GeoMesh, PrimitiveField >::operator=(), GeometricField< Type, GeoMesh, PrimitiveField >::operator==(), Foam::pow(), pointFieldReconstructor::reconstructField(), fvFieldReconstructor::reconstructFvSurfaceField(), fvFieldReconstructor::reconstructVolField(), GeometricField< Type, GeoMesh, PrimitiveField >::reset(), rigidBodyMeshMotion::rigidBodyMeshMotion(), sampledIsoSurfaceSurface::sampleField(), patchInternalField::sampleField(), multiphaseVoFSolver::setInterfaceRDeltaT(), twoPhaseVoFSolver::setInterfaceRDeltaT(), incompressibleFluid::setRDeltaT(), sixDoFRigidBodyMotionSolver::sixDoFRigidBodyMotionSolver(), SlicedGeometricField< Type, GeoMesh >::SlicedGeometricField(), phaseSystem::solve(), Foam::sqr(), Foam::stabilise(), Foam::T(), Foam::transform(), Foam::fvc::volumeIntegrate(), clippedLinear< Type >::weights(), and reverseLinear< Type >::weights().

Here is the caller graph for this function:

◆ boundaryFieldRef()

Foam::GeometricField< Type, GeoMesh, PrimitiveField >::Boundary & boundaryFieldRef

Return a reference to the boundary field.

Note: this increments the event counter and checks the old-time fields; avoid in loops.

Definition at line 1398 of file GeometricField.C.

Referenced by MRFZone::addCentrifugalAcceleration(), Foam::adjustPhi(), Foam::atan2(), Foam::fvc::average(), Foam::bound(), Foam::constrainPhid(), PDRkEpsilon::correct(), mixtureKEpsilon< BasicMomentumTransportModel >::correct(), advectionDiffusion::correct(), gaussGrad< Type >::correctBoundaryConditions(), motionSmootherAlgo::correctBoundaryConditions(), phaseSystem::correctBoundaryFlux(), Foam::correctFixedFluxBCs(), phaseModel::correctInflowOutflow(), linearUpwindV< Type >::correction(), cubic< Type >::correction(), linearUpwind< Type >::correction(), phaseSystem::correctPhi(), Foam::correctUphiBCs(), fvFieldDecomposer::decomposeFvSurfaceField(), fvFieldDecomposer::decomposeVolField(), Foam::saturationModels::evaluate(), Foam::evaluate(), wallBoilingProperty::execute(), fvMatrix< Type >::flux(), ddtScheme< Type >::fvcDdtPhiCoeff(), fvMatrix< Type >::fvMatrix(), psiuMulticomponentThermo::heuBoundaryCorrection(), wallCellWallFunctionFvPatchScalarField::initMaster(), singleCellFvMesh::interpolate(), localMax< Type >::interpolate(), localMin< Type >::interpolate(), fvMeshSubset::interpolate(), interfaceCompressionNew::interpolate(), momentumTransferSystem::invADVs(), Foam::levelSetFraction(), Foam::MULES::limit(), PhiScheme< Type, PhiLimiter >::limiter(), Foam::mag(), Foam::magSqr(), makeMomentumTransportModelTypes(), Foam::MapGeometricFields(), fvMesh::movePoints(), JohnsonJacksonSchaeffer::nu(), Schaeffer::nu(), consumptionSpeed::omega0Sigma(), inversePointDistanceDiffusivity::operator()(), fvPatch::patchField(), Foam::pow(), shockFluid::pressureCorrector(), constSolidThermo::readProperty(), nearWallFields::sampleBoundaryField(), setCellFieldType(), motionSmootherAlgo::setDisplacementPatchFields(), setFaceFieldType(), pointConstraints::setPatchFields(), snGradScheme< Type >::snGrad(), Foam::stabilise(), MPLIC::surfaceAlpha(), Foam::T(), Foam::transform(), waveSurfacePressureFvPatchScalarField::updateCoeffs(), greyDiffusiveRadiationMixedFvPatchScalarField::updateCoeffs(), wideBandDiffusiveRadiationMixedFvPatchScalarField::updateCoeffs(), extendedCellToFaceStencil::weightedSum(), clippedLinear< Type >::weights(), reverseLinear< Type >::weights(), limitedSurfaceInterpolationScheme< Type >::weights(), SCOPEXiEq::XiEq(), MRFZone::zero(), and wallLubricationModel::zeroGradWalls().

Here is the caller graph for this function:

◆ boundaryFieldRefNoStoreOldTimes()

Foam::GeometricField< Type, GeoMesh, PrimitiveField >::Boundary & boundaryFieldRefNoStoreOldTimes

Return a reference to the boundary field without storing old times.

Note: this increments the event counter; avoid in loops.

Definition at line 1409 of file GeometricField.C.

◆ boundaryField()

const Foam::GeometricField< Type, GeoMesh, PrimitiveField >::Boundary & boundaryField

inline

Return const-reference to the boundary field.

Definition at line 59 of file GeometricFieldI.H.

Here is the caller graph for this function:

◆ sourcesRef()

Foam::GeometricField< Type, GeoMesh, PrimitiveField >::Sources & sourcesRef

Return a reference to the sources.

Note: this increments the event counter and checks the old-time fields; avoid in loops.

Definition at line 1420 of file GeometricField.C.

◆ sources()

const Foam::GeometricField< Type, GeoMesh, PrimitiveField >::Sources & sources

inline

Return const-reference to the sources.

Definition at line 68 of file GeometricFieldI.H.

Referenced by fvSpecificSource::addSupType(), fvTotalSource::addSupType(), fvFieldDecomposer::decomposeVolField(), fvFieldSource< Type >::fieldSource(), LagrangianFieldSource< Type >::fieldSource(), growthSecondaryPropertyFvScalarFieldSource::internalCoeff(), energyFvScalarFieldSource::internalCoeff(), GeometricField< Type, GeoMesh, PrimitiveField >::operator/=(), GeometricField< Type, GeoMesh, PrimitiveField >::reset(), growthSecondaryPropertyFvScalarFieldSource::sourceCoeffs(), and energyFvScalarFieldSource::sourceValue().

Here is the caller graph for this function:

◆ storePrevIter()

void storePrevIter

Store the field as the previous iteration value.

Definition at line 1429 of file GeometricField.C.

References Foam::endl(), InfoInFunction, and Foam::name().

Referenced by singleRegionSolutionControl::storePrevIterTypeFields().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ clearPrevIter()

void clearPrevIter

Delete the previous iteration field.

Definition at line 1455 of file GeometricField.C.

References Foam::deleteDemandDrivenData().

Here is the call graph for this function:

◆ prevIter()

const Foam::GeometricField< Type, GeoMesh, Foam::Field > & prevIter

Return previous iteration field.

Definition at line 1463 of file GeometricField.C.

References Foam::abort(), Foam::endl(), Foam::FatalError, and FatalErrorInFunction.

Here is the call graph for this function:

◆ USING_OLD_TIME_FIELD()

USING_OLD_TIME_FIELD ( GeometricField< Type, GeoMesh, PrimitiveField > )

Use old-time methods from the base class.

◆ correctBoundaryConditions()

void correctBoundaryConditions

Correct boundary field.

Definition at line 1479 of file GeometricField.C.

Referenced by porosityModel::addResistance(), MomentumCloud< CloudType >::alpha(), Foam::fvc::average(), cellCoBlended< Type >::blendingFactor(), Implicit< CloudType >::cacheFields(), cellMDLimitedGrad< Type >::calcGrad(), faceLimitedGrad< Type >::calcGrad(), faceMDLimitedGrad< Type >::calcGrad(), pointConstraints::constrain(), pointConstraints::constrainDisplacement(), PDRkEpsilon::correct(), mixtureKEpsilon< BasicMomentumTransportModel >::correct(), SlicedGeometricField< Type, GeoMesh >::correctBoundaryConditions(), SpalartAllmarasDES< BasicMomentumTransportModel >::correctNut(), SpalartAllmaras< BasicMomentumTransportModel >::correctNut(), incompressibleDenseParticleFluid::correctPressure(), incompressibleFluid::correctPressure(), fvMatrix< Type >::H(), fvMatrix< Type >::H1(), incompressibleDenseParticleFluid::incompressibleDenseParticleFluid(), twoPhaseSolver::incompressiblePressureCorrector(), SpalartAllmarasDES< BasicMomentumTransportModel >::k(), makeMomentumTransportModelTypes(), JohnsonJacksonSchaeffer::nu(), Schaeffer::nu(), inverseVolumeDiffusivity::operator()(), compressibleMultiphaseVoF::pressureCorrector(), compressibleVoF::pressureCorrector(), incompressibleMultiphaseVoF::pressureCorrector(), shockFluid::pressureCorrector(), constSolidThermo::readProperty(), multiphaseVoFSolver::setInterfaceRDeltaT(), twoPhaseVoFSolver::setInterfaceRDeltaT(), incompressibleFluid::setRDeltaT(), Foam::fvc::smooth(), Foam::fvc::spread(), Foam::fvc::surfaceIntegrateExtrapolate(), Foam::fvc::sweep(), multicomponentFluid::thermophysicalPredictor(), MomentumCloud< CloudType >::vDotSweep(), and regionSizeDistribution::write().

Here is the caller graph for this function:

◆ reset() [1/3]

void reset ( const GeometricField< Type, GeoMesh, PrimitiveField2 > & gf )

Reset the field contents to the given field.

Used for mesh to mesh mapping

Definition at line 1490 of file GeometricField.C.

References GeometricField< Type, GeoMesh, PrimitiveField >::boundaryField(), and GeometricField< Type, GeoMesh, PrimitiveField >::sources().

Referenced by Foam::MeshToMeshMapVolFields().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ reset() [2/3]

void reset ( const tmp< GeometricField< Type, GeoMesh, PrimitiveField >> & tgf )

Reset the field contents to the given tmp-field.

Used for mesh to mesh mapping

Definition at line 1503 of file GeometricField.C.

References GeometricField< Type, GeoMesh, PrimitiveField >::boundaryField(), checkFieldAssignment, Foam::dimensions(), DimensionedField< Type, GeoMesh, PrimitiveField >::dimensions(), GeometricField< Type, GeoMesh, PrimitiveField >::primitiveField(), and GeometricField< Type, GeoMesh, PrimitiveField >::sources().

Here is the call graph for this function:

◆ reset() [3/3]

void reset ( const tmp< GeometricField< Type, GeoMesh, PrimitiveField2 >> & tgf )

Reset the field contents to the given tmp-field.

Used for mesh to mesh mapping

Definition at line 1532 of file GeometricField.C.

◆ needReference()

bool needReference

Does the field need a reference level for solution.

Definition at line 1544 of file GeometricField.C.

References forAll, patchi, and Foam::reduce().

Referenced by Foam::fv::CorrectPhi(), incompressibleDenseParticleFluid::correctPressure(), incompressibleFluid::correctPressure(), twoPhaseSolver::incompressiblePressureCorrector(), incompressibleMultiphaseVoF::pressureCorrector(), and Foam::setRefCell().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ component() [1/3]

tmp<GeometricField<cmptType, GeoMesh, Field> > component ( const direction ) const

Return a component of the field.

Referenced by anisotropicFilter::anisotropicFilter(), correctedSnGrad< Type >::correction(), faceCorrectedSnGrad< Type >::correction(), linearUpwind< Type >::correction(), cubic< Type >::correction(), Foam::fvc::magSqrGradGrad(), skewCorrected< Type >::skewCorrection(), and fvMatrix< Type >::solveCoupled().

Here is the caller graph for this function:

◆ writeData()

bool writeData ( Ostream & os ) const

virtual

WriteData member function required by regIOobject.

Reimplemented from DimensionedField< Type, GeoMesh, PrimitiveField >.

Definition at line 1687 of file GeometricField.C.

References IOstream::good().

Referenced by GeometricField< Type, GeoMesh, PrimitiveField >::operator/=().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ T()

Foam::tmp< Foam::GeometricField< Type, GeoMesh, Foam::Field > > T

Return transpose (only if it is a tensor field)

Definition at line 1701 of file GeometricField.C.

References Foam::dimensions(), mesh, Foam::name(), tmp< T >::ref(), and Foam::T().

Referenced by compressibleVoFphase::compressibleVoFphase(), IsothermalPhaseModel< BasePhaseModel >::correctThermo(), ReynoldsStress< BasicMomentumTransportModel >::Refff(), and displacementSBRStressFvMotionSolver::solve().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ relax() [1/4]

void relax ( const scalar alpha )

Relax field (for steady-state solution).

alpha >= 1 : no relaxation alpha < 1 : relaxation

Definition at line 1567 of file GeometricField.C.

References alpha(), Foam::endl(), InfoInFunction, and Foam::operator==().

Referenced by incompressibleDenseParticleFluid::correctPressure(), incompressibleFluid::correctPressure(), twoPhaseSolver::incompressiblePressureCorrector(), main(), and incompressibleMultiphaseVoF::pressureCorrector().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ relaxationFactor()

Foam::scalar relaxationFactor

Return the field relaxation factor read from fvSolution.

or 1 if not specified

Definition at line 1588 of file GeometricField.C.

References solution::fieldRelaxationFactor(), solutionControl::finalIteration(), mesh, Foam::name(), and fvMesh::solution().

Here is the call graph for this function:

◆ relax() [2/4]

void relax

Relax current field with respect to the cached previous iteration.

Relaxation factor is read from fvSolution

Definition at line 1613 of file GeometricField.C.

References relax().

Here is the call graph for this function:

◆ relax() [3/4]

void relax	(	const tmp< GeometricField< Type, GeoMesh, PrimitiveField2 >> &	tgf,
		const scalar	alpha
	)

Relax given field with respect to the current field.

and reset the field to the result

Definition at line 1621 of file GeometricField.C.

References alpha(), Foam::endl(), InfoInFunction, and Foam::operator==().

Here is the call graph for this function:

◆ relax() [4/4]

void relax ( const tmp< GeometricField< Type, GeoMesh, PrimitiveField2 >> & tgf )

Relax given field with respect to the current field.

and reset the field to the result Relaxation factor is read from fvSolution

Definition at line 1647 of file GeometricField.C.

References relax().

Here is the call graph for this function:

◆ select()

Foam::word select ( bool final ) const

Select the final iteration parameters if `final' is true.

by returning the field name + "Final" otherwise the standard parameters by returning the field name

Definition at line 1657 of file GeometricField.C.

References Foam::name().

Here is the call graph for this function:

◆ writeMinMax()

void writeMinMax ( Ostream & os ) const

Helper function to write the min and max to an Ostream.

Definition at line 1674 of file GeometricField.C.

References Foam::endl(), Foam::max(), Foam::min(), and Foam::name().

Here is the call graph for this function:

◆ negate()

void negate

Definition at line 1840 of file GeometricField.C.

References primitiveFieldRef().

Here is the call graph for this function:

◆ replace() [1/7]

void replace	(	const	direction,
		const GeometricField< cmptType, GeoMesh, PrimitiveField2 > &
	)

Replace a component field of the field.

Referenced by correctedSnGrad< Type >::correction(), faceCorrectedSnGrad< Type >::correction(), cubic< Type >::correction(), fvMatrix< Type >::H(), and fvMatrix< Type >::solveSegregated().

Here is the caller graph for this function:

◆ replace() [2/7]

void replace	(	const	direction,
		const tmp< GeometricField< cmptType, GeoMesh, PrimitiveField2 >> &
	)

Replace a component field of the field.

◆ replace() [3/7]

void replace	(	const direction	d,
		const dimensioned< cmptType > &	ds
	)

Replace a component field of the field.

Definition at line 1792 of file GeometricField.C.

References primitiveFieldRef(), and dimensioned< Type >::value().

Here is the call graph for this function:

◆ max()

void max ( const dimensioned< Type > & dt )

Definition at line 1804 of file GeometricField.C.

References Foam::max(), primitiveFieldRef(), and dimensioned< Type >::value().

Referenced by Moraga::Cl(), Foam::combine(), massFractions::execute(), and incompressibleFluid::setRDeltaT().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ min()

void min ( const dimensioned< Type > & dt )

Definition at line 1815 of file GeometricField.C.

References Foam::min(), primitiveFieldRef(), and dimensioned< Type >::value().

Referenced by Moraga::Cl(), Foam::combine(), and incompressibleFluid::setRDeltaT().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ maxMin()

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

Definition at line 1826 of file GeometricField.C.

References Foam::max(), Foam::min(), primitiveFieldRef(), and dimensioned< Type >::value().

Referenced by comfort::execute(), and phaseSystem::solve().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ operator()()

const Foam::GeometricField< Type, GeoMesh, PrimitiveField >::Internal & operator()

inline

Return a const-reference to the dimensioned internal field.

Useful in the formulation of source-terms for FV equations

Definition at line 79 of file GeometricFieldI.H.

◆ operator=() [1/7]

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

Definition at line 1850 of file GeometricField.C.

References GeometricField< Type, GeoMesh, PrimitiveField >::boundaryField(), checkFieldAssignment, checkFieldOperation, and GeometricField< Type, GeoMesh, PrimitiveField >::internalField().

Here is the call graph for this function:

◆ operator=() [2/7]

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

Definition at line 1864 of file GeometricField.C.

References GeometricField< Type, GeoMesh, PrimitiveField >::boundaryField(), checkFieldAssignment, checkFieldOperation, and GeometricField< Type, GeoMesh, PrimitiveField >::internalField().

Here is the call graph for this function:

◆ operator=() [3/7]

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

Definition at line 1879 of file GeometricField.C.

References GeometricField< Type, GeoMesh, PrimitiveField >::boundaryField(), checkFieldOperation, and GeometricField< Type, GeoMesh, PrimitiveField >::internalField().

Here is the call graph for this function:

◆ operator=() [4/7]

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

Definition at line 1892 of file GeometricField.C.

References GeometricField< Type, GeoMesh, PrimitiveField >::boundaryField(), checkFieldAssignment, checkFieldOperation, PtrList< T >::clear(), Foam::dimensions(), DimensionedField< Type, GeoMesh, PrimitiveField >::dimensions(), GeometricField< Type, GeoMesh, PrimitiveField >::primitiveField(), and primitiveFieldRef().

Here is the call graph for this function:

◆ operator=() [5/7]

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

Definition at line 1921 of file GeometricField.C.

References GeometricField< Type, GeoMesh, PrimitiveField >::boundaryField(), checkFieldOperation, PtrList< T >::clear(), and GeometricField< Type, GeoMesh, PrimitiveField >::internalField().

Here is the call graph for this function:

◆ operator=() [6/7]

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

Definition at line 1938 of file GeometricField.C.

References dimensioned< Type >::value().

Here is the call graph for this function:

◆ operator=() [7/7]

void operator= ( const zero & )

Definition at line 1949 of file GeometricField.C.

References Foam::Zero.

◆ operator==() [1/5]

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

Definition at line 1961 of file GeometricField.C.

References GeometricField< Type, GeoMesh, PrimitiveField >::boundaryField(), checkFieldOperation, and GeometricField< Type, GeoMesh, PrimitiveField >::internalField().

Here is the call graph for this function:

◆ operator==() [2/5]

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

Definition at line 1974 of file GeometricField.C.

References GeometricField< Type, GeoMesh, PrimitiveField >::boundaryField(), checkFieldOperation, PtrList< T >::clear(), Foam::dimensions(), DimensionedField< Type, GeoMesh, PrimitiveField >::dimensions(), GeometricField< Type, GeoMesh, PrimitiveField >::primitiveField(), and primitiveFieldRef().

Here is the call graph for this function:

◆ operator==() [3/5]

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

Definition at line 2002 of file GeometricField.C.

References GeometricField< Type, GeoMesh, PrimitiveField >::boundaryField(), checkFieldOperation, PtrList< T >::clear(), and GeometricField< Type, GeoMesh, PrimitiveField >::internalField().

Here is the call graph for this function:

◆ operator==() [4/5]

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

Definition at line 2019 of file GeometricField.C.

References dimensioned< Type >::value().

Here is the call graph for this function:

◆ operator==() [5/5]

void operator== ( const zero & )

Definition at line 2030 of file GeometricField.C.

References Foam::Zero.

◆ operator+=() [1/3]

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

Definition at line 2076 of file GeometricField.C.

◆ operator+=() [2/3]

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

Definition at line 2076 of file GeometricField.C.

◆ operator+=() [3/3]

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

Definition at line 2076 of file GeometricField.C.

◆ operator-=() [1/3]

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

Definition at line 2077 of file GeometricField.C.

◆ operator-=() [2/3]

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

Definition at line 2077 of file GeometricField.C.

◆ operator-=() [3/3]

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

Definition at line 2077 of file GeometricField.C.

◆ operator*=() [1/3]

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

Definition at line 2078 of file GeometricField.C.

◆ operator*=() [2/3]

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

Definition at line 2078 of file GeometricField.C.

◆ operator*=() [3/3]

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

Definition at line 2078 of file GeometricField.C.

◆ operator/=() [1/3]

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

Definition at line 2079 of file GeometricField.C.

References GeometricField< Type, GeoMesh, PrimitiveField >::boundaryField(), Foam::nl, GeometricField< Type, GeoMesh, PrimitiveField >::sources(), GeometricField< Type, GeoMesh, PrimitiveField >::writeData(), GeometricBoundaryField< Type, GeoMesh, PrimitiveField >::writeEntry(), and GeometricFieldSources< Type, GeoMesh, PrimitiveField >::writeEntry().

Here is the call graph for this function:

◆ operator/=() [2/3]

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

Definition at line 2079 of file GeometricField.C.

◆ operator/=() [3/3]

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

Definition at line 2079 of file GeometricField.C.

◆ component() [2/3]

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

inline

◆ replace() [4/7]

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

inline

◆ component() [3/3]

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

inline

Definition at line 38 of file volFieldsI.H.

◆ replace() [5/7]

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

inline

Definition at line 49 of file volFieldsI.H.

◆ New() [14/17]

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

Definition at line 1080 of file GeometricField.C.

References objectRegistry::cacheTemporaryObject(), IOobject::db(), IOobject::instance(), IOobject::local(), IOobject::NO_READ, IOobject::NO_WRITE, and Foam::patchFieldType().

Here is the call graph for this function:

◆ New() [15/17]

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

Definition at line 1147 of file GeometricField.C.

References objectRegistry::cacheTemporaryObject(), IOobject::db(), IOobject::instance(), IOobject::local(), IOobject::NO_READ, IOobject::NO_WRITE, and Foam::patchFieldType().

Here is the call graph for this function:

◆ New() [16/17]

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
	)

Definition at line 1214 of file GeometricField.C.

References objectRegistry::cacheTemporaryObject(), IOobject::db(), IOobject::instance(), IOobject::local(), IOobject::NO_READ, and IOobject::NO_WRITE.

Here is the call graph for this function:

◆ New() [17/17]

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
	)

Definition at line 1289 of file GeometricField.C.

References objectRegistry::cacheTemporaryObject(), IOobject::db(), IOobject::instance(), IOobject::local(), IOobject::NO_READ, and IOobject::NO_WRITE.

Here is the call graph for this function:

◆ replace() [6/7]

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

Definition at line 1754 of file GeometricField.C.

References primitiveFieldRef().

Here is the call graph for this function:

◆ replace() [7/7]

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

Definition at line 1772 of file GeometricField.C.

Friends And Related Function Documentation

◆ GeometricField

friend class GeometricField

friend

Declare friendship with other geometric fields.

Definition at line 144 of file GeometricField.H.

◆ operator [1/2]

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

friend

◆ operator [2/2]

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

friend

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

src/OpenFOAM/fields/GeometricFields/GeometricField/GeometricField.H
src/finiteVolume/fields/volFields/volFieldsI.H
src/OpenFOAM/fields/GeometricFields/GeometricField/GeometricField.C
src/OpenFOAM/fields/GeometricFields/GeometricField/GeometricFieldI.H

Public Types

Public Member Functions

Static Public Member Functions

Friends

Additional Inherited Members

Detailed Description

template<class Type, class GeoMesh, template< class > class PrimitiveField> class Foam::GeometricField< Type, GeoMesh, PrimitiveField >

Member Typedef Documentation

◆ Mesh

◆ Internal

◆ Base

◆ Patch

◆ Boundary

◆ Source

◆ Sources

◆ cmptType

Constructor & Destructor Documentation

◆ GeometricField() [1/24]

◆ GeometricField() [2/24]

◆ GeometricField() [3/24]

◆ GeometricField() [4/24]

◆ GeometricField() [5/24]

◆ GeometricField() [6/24]

◆ GeometricField() [7/24]

◆ GeometricField() [8/24]

◆ GeometricField() [9/24]

◆ GeometricField() [10/24]

◆ GeometricField() [11/24]

◆ GeometricField() [12/24]

◆ GeometricField() [13/24]

◆ GeometricField() [14/24]

◆ GeometricField() [15/24]

◆ GeometricField() [16/24]

◆ GeometricField() [17/24]

◆ GeometricField() [18/24]

◆ GeometricField() [19/24]

◆ GeometricField() [20/24]

◆ GeometricField() [21/24]

◆ GeometricField() [22/24]

◆ GeometricField() [23/24]

◆ GeometricField() [24/24]

◆ ~GeometricField()

Member Function Documentation

◆ TypeName()

◆ null()

◆ clone()

◆ cloneUnSliced()

◆ New() [1/17]

◆ New() [2/17]

◆ New() [3/17]

◆ New() [4/17]

◆ New() [5/17]

◆ New() [6/17]

◆ New() [7/17]

◆ New() [8/17]

◆ New() [9/17]

◆ New() [10/17]

◆ New() [11/17]

◆ New() [12/17]

◆ New() [13/17]

◆ internalFieldRef()

◆ internalField()

◆ v()

◆ primitiveFieldRef()

◆ primitiveField()

◆ boundaryFieldRef()

◆ boundaryFieldRefNoStoreOldTimes()

◆ boundaryField()

◆ sourcesRef()

◆ sources()

◆ storePrevIter()

◆ clearPrevIter()

◆ prevIter()

◆ USING_OLD_TIME_FIELD()

◆ correctBoundaryConditions()

◆ reset() [1/3]

◆ reset() [2/3]

◆ reset() [3/3]

◆ needReference()

◆ component() [1/3]

template<class Type, class GeoMesh, template< class > class PrimitiveField>
class Foam::GeometricField< Type, GeoMesh, PrimitiveField >