Base class for lagrangian averaging methods. More...

Inheritance diagram for AveragingMethod< Type >:

[legend]

Collaboration diagram for AveragingMethod< Type >:

[legend]

Public Member Functions
	TypeName ("averagingMethod")
	Runtime type information. More...

	declareRunTimeSelectionTable (autoPtr, AveragingMethod, dictionary,(const IOobject &io, const dictionary &dict, const fvMesh &mesh),(io, dict, mesh))
	Declare runtime constructor selection table. More...

	AveragingMethod (const IOobject &io, const dictionary &dict, const fvMesh &mesh, const labelList &size)
	Constructors. More...

	AveragingMethod (const AveragingMethod< Type > &am)
	Construct a copy. More...

virtual autoPtr< AveragingMethod< Type > >	clone () const =0
	Construct and return a clone. More...

virtual	~AveragingMethod ()
	Destructor. More...

virtual void	add (const point position, const tetIndices &tetIs, const Type &value)=0
	Member Functions. More...

virtual Type	interpolate (const point position, const tetIndices &tetIs) const =0
	Interpolate. More...

virtual TypeGrad	interpolateGrad (const point position, const tetIndices &tetIs) const =0
	Interpolate gradient. More...

virtual void	average ()
	Calculate the average. More...

virtual void	average (const AveragingMethod< scalar > &weight)

virtual bool	writeData (Ostream &) const
	Dummy write. More...

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

virtual tmp< Field< Type > >	primitiveField () const =0
	Return an internal field of the average. More...

void	operator= (const AveragingMethod< Type > &x)
	Assign to another average. More...

void	operator= (const Type &x)
	Assign to value. More...

void	operator= (tmp< FieldField< Field, Type >> x)
	Assign to tmp. More...

void	operator+= (tmp< FieldField< Field, Type >> x)
	Add-equal tmp. More...

void	operator*= (tmp< FieldField< Field, Type >> x)
	Multiply-equal tmp. More...

void	operator/= (tmp< FieldField< Field, scalar >> x)
	Divide-equal tmp. More...

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

	regIOobject (const IOobject &, const bool isTime=false)
	Construct from IOobject. Optional flag for if IOobject is the. More...

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

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

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

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

virtual	~regIOobject ()
	Destructor. More...

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

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

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

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

void	release ()
	Release ownership of this object from its registry. More...

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

label &	eventNo ()
	Event number at last update. More...

bool	upToDate (const regIOobject &) const
	Return true if up-to-date with respect to given object. More...

bool	upToDate (const regIOobject &, const regIOobject &) const
	Return true if up-to-date with respect to given objects. More...

bool	upToDate (const regIOobject &, const regIOobject &, const regIOobject &) const
	Return true if up-to-date with respect to given objects. More...

bool	upToDate (const regIOobject &, const regIOobject &, const regIOobject &, const regIOobject &) const
	Return true if up-to-date with respect to given objects. More...

void	setUpToDate ()
	Set up to date (obviously) More...

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

Istream &	readStream (const word &)
	Return Istream and check object type against that given. More...

void	close ()
	Close Istream. More...

virtual bool	readData (Istream &)
	Virtual readData function. More...

virtual bool	read ()
	Read object. More...

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

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

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

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

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

void	operator= (const IOobject &)

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

	IOobject (const word &name, const fileName &instance, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true)
	Construct from name, instance, registry, io options. More...

	IOobject (const word &name, const fileName &instance, const fileName &local, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true)
	Construct from name, instance, local, registry, io options. More...

	IOobject (const fileName &path, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true)
	Construct from path, registry, io options. More...

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

virtual	~IOobject ()
	Destructor. More...

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

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

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

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

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

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

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

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

readOption	readOpt () const

readOption &	readOpt ()

writeOption	writeOpt () const

writeOption &	writeOpt ()

word	group () const
	Return group (extension part of name) More...

word	member () const
	Return member (name without the extension) More...

const fileName &	rootPath () const

const fileName &	caseName () const

const fileName &	instance () const

fileName &	instance ()

const fileName &	local () const

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

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

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

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

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

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

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

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

bool	good () const

bool	bad () const

InfoProxy< IOobject >	info () const
	Return info proxy. More...

void	operator= (const IOobject &)

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

Public Member Functions inherited from FieldField< Field, Type >
	FieldField ()
	Construct null. More...

	FieldField (const label)
	Construct given size. More...

	FieldField (const word &, const FieldField< Field, Type > &)
	Construct using the Field sizes from the given FieldField. More...

	FieldField (const FieldField< Field, Type > &)
	Construct as copy. More...

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

	FieldField (const PtrList< Field< Type >> &)
	Construct as copy of a PtrList<Field, Type> More...

	FieldField (const tmp< FieldField< Field, Type >> &)
	Construct as copy of tmp<FieldField> More...

	FieldField (Istream &)
	Construct from Istream. More...

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

void	negate ()
	Negate this field. More...

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

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

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

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

void	operator= (const FieldField< Field, Type > &)

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

void	operator= (const Type &)

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

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

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

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

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

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

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

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

void	operator+= (const Type &)

void	operator-= (const Type &)

void	operator*= (const scalar &)

void	operator/= (const scalar &)

Public Member Functions inherited from refCount
int	count () const
	Return the current reference count. More...

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

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

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

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

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

Public Member Functions inherited from PtrList< Field< Type > >
	PtrList ()
	Null Constructor. More...

	PtrList (const label)
	Construct with size specified. More...

	PtrList (const PtrList< Field< Type > > &)
	Copy constructor. More...

	PtrList (const PtrList< Field< Type > > &, const CloneArg &)
	Copy constructor with additional argument for clone. More...

	PtrList (const Xfer< PtrList< Field< Type > >> &)
	Construct by transferring the parameter contents. More...

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

	PtrList (const SLPtrList< Field< Type > > &)
	Construct as copy of SLPtrList<T> More...

	PtrList (Istream &, const INew &)
	Construct from Istream using given Istream constructor class. More...

	PtrList (Istream &)
	Construct from Istream using default Istream constructor class. More...

	~PtrList ()
	Destructor. More...

void	setSize (const label)
	Reset size of PtrList. If extending the PtrList, new entries are. More...

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

void	clear ()
	Clear the PtrList, i.e. set size to zero deleting all the. More...

void	append (Field< Type > *)
	Append an element at the end of the list. More...

void	append (const autoPtr< Field< Type > > &)

void	append (const tmp< Field< Type > > &)

void	transfer (PtrList< Field< Type > > &)
	Transfer the contents of the argument PtrList into this PtrList. More...

Xfer< PtrList< Field< Type > > >	xfer ()
	Transfer contents to the Xfer container. More...

bool	set (const label) const
	Is element set. More...

autoPtr< Field< Type > >	set (const label, Field< Type > *)
	Set element to given T* and return old element (can be NULL) More...

autoPtr< Field< Type > >	set (const label, const autoPtr< Field< Type > > &)
	Set element to given autoPtr<T> and return old element. More...

autoPtr< Field< Type > >	set (const label, const tmp< Field< Type > > &)
	Set element to given tmp<T> and return old element. More...

void	reorder (const labelUList &)
	Reorders elements. Ordering does not have to be done in. More...

void	operator= (const PtrList< Field< Type > > &)
	Assignment. More...

Public Member Functions inherited from UPtrList< T >
	UPtrList ()
	Null Constructor. More...

	UPtrList (const label)
	Construct with size specified. More...

	UPtrList (const Xfer< UPtrList< T >> &)
	Construct by transferring the parameter contents. More...

	UPtrList (UPtrList< T > &, bool reuse)
	Construct as copy or re-use as specified. More...

label	size () const
	Return the number of elements in the UPtrList. More...

bool	empty () const
	Return true if the UPtrList is empty (ie, size() is zero) More...

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

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

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

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

void	setSize (const label)
	Reset size of UPtrList. This can only be used to set the size. More...

void	resize (const label)
	Reset size of UPtrList. This can only be used to set the size. More...

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

void	transfer (UPtrList< T > &)
	Transfer the contents of the argument UPtrList into this. More...

Xfer< UPtrList< T > >	xfer ()
	Transfer contents to the Xfer container. More...

bool	set (const label) const
	Is element set. More...

T *	set (const label, T *)
	Set element. Return old element (can be NULL). More...

void	reorder (const labelUList &)
	Reorders elements. Ordering does not have to be done in. More...

const T &	operator[] (const label) const
	Return element const reference. More...

T &	operator[] (const label)
	Return element reference. More...

const T *	operator() (const label) const
	Return element const pointer. More...

iterator	begin ()
	Return an iterator to begin traversing the UPtrList. More...

iterator	end ()
	Return an iterator to end traversing the UPtrList. More...

const_iterator	cbegin () const
	Return an const_iterator to begin traversing the UPtrList. More...

const_iterator	cend () const
	Return an const_iterator to end traversing the UPtrList. More...

const_iterator	begin () const
	Return an const_iterator to begin traversing the UPtrList. More...

const_iterator	end () const
	Return an const_iterator to end traversing the UPtrList. More...

Static Public Member Functions
static autoPtr< AveragingMethod< Type > >	New (const IOobject &io, const dictionary &dict, const fvMesh &mesh)
	Selector. More...

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

template<class Type >
static Type &	store (autoPtr< Type > &)
	Transfer ownership of the given object pointer to its registry. More...

Static Public Member Functions inherited from IOobject
static bool	fileNameComponents (const fileName &path, fileName &instance, fileName &local, word &name)
	Split path into instance, local, name components. More...

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

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

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

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

Static Public Member Functions inherited from FieldField< Field, Type >
template<class Type2 >
static tmp< FieldField< Field, Type > >	NewCalculatedType (const FieldField< Field, Type2 > &ff)
	Return a pointer to a new calculatedFvPatchFieldField created on. More...

Protected Types
typedef outerProduct< vector, Type >::type	TypeGrad
	Protected typedefs. More...

Protected Member Functions
virtual void	updateGrad ()
	Protected member functions. More...

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

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

void	setBad (const string &)
	Set the object state to bad. More...

Protected Member Functions inherited from refCount
	refCount ()
	Construct null initializing count to 0. More...

Protected Member Functions inherited from PtrList< Field< Type > >
void	read (Istream &, const INew &inewt)
	Read from Istream using given Istream constructor class. More...

Protected Attributes
const dictionary &	dict_
	Protected data. More...

const fvMesh &	mesh_
	The mesh on which the averaging is to be done. More...

Additional Inherited Members
Public Types inherited from regIOobject
enum	fileCheckTypes { timeStamp, timeStampMaster, inotify, inotifyMaster }
	Types of communications. More...

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

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

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

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

Public Types inherited from UPtrList< T >
typedef T	value_type
	Type of values the UPtrList contains. More...

typedef T &	reference
	Type that can be used for storing into UPtrList::value_type objects. More...

typedef const T &	const_reference
	Type that can be used for storing into constant UPtrList::value_type. More...

Static Public Attributes inherited from regIOobject
static const NamedEnum< fileCheckTypes, 4 >	fileCheckTypesNames

static int	fileModificationSkew

static fileCheckTypes	fileModificationChecking

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

Detailed Description

template<class Type>
class Foam::AveragingMethod< Type >

Base class for lagrangian averaging methods.

Source files

Definition at line 55 of file MPPICParcel.H.

Member Typedef Documentation

typedef outerProduct<vector, Type>::type TypeGrad

protected

Protected typedefs.

Gradient type

Definition at line 62 of file AveragingMethod.H.

Constructor & Destructor Documentation

AveragingMethod	(	const IOobject &	io,
		const dictionary &	dict,
		const fvMesh &	mesh,
		const labelList &	size
	)

Constructors.

Construct from components

Definition at line 34 of file AveragingMethod.C.

References forAll, and Foam::Zero.

AveragingMethod ( const AveragingMethod< Type > & am )

Construct a copy.

Definition at line 58 of file AveragingMethod.C.

References AveragingMethod< Type >::New().

Here is the call graph for this function:

~AveragingMethod ( )

virtual

Destructor.

Definition at line 105 of file AveragingMethod.C.

Member Function Documentation

void updateGrad ( )

protectedvirtual

Protected member functions.

Update the gradient calculation

Definition at line 112 of file AveragingMethod.C.

TypeName ( "averagingMethod" )

Runtime type information.

declareRunTimeSelectionTable	(	autoPtr	,
		AveragingMethod< Type >	,
		dictionary	,
		(const IOobject &io, const dictionary &dict, const fvMesh &mesh)	,
		(io, dict, mesh)
	)

Declare runtime constructor selection table.

virtual autoPtr<AveragingMethod<Type> > clone ( ) const

pure virtual

Construct and return a clone.

Implemented in Dual< Type >, Moment< Type >, and Basic< Type >.

Foam::autoPtr< Foam::AveragingMethod< Type > > New	(	const IOobject &	io,
		const dictionary &	dict,
		const fvMesh &	mesh
	)

static

Selector.

Definition at line 74 of file AveragingMethod.C.

References Foam::abort(), dict, Foam::FatalError, FatalErrorInFunction, dictionary::lookup(), mesh, and Foam::nl.

Referenced by AveragingMethod< Type >::AveragingMethod().

Here is the call graph for this function:

Here is the caller graph for this function:

virtual void add	(	const point	position,
		const tetIndices &	tetIs,
		const Type &	value
	)

pure virtual

Member Functions.

Add point value to interpolation

Implemented in Dual< Type >, Moment< Type >, and Basic< Type >.

Referenced by Stochastic< CloudType >::calculate(), and MPPICParcel< ParcelType >::TrackingData< CloudType >::updateAverages().

Here is the caller graph for this function:

virtual Type interpolate	(	const point	position,
		const tetIndices &	tetIs
	)		const

pure virtual

Interpolate.

Implemented in Dual< Type >, Moment< Type >, and Basic< Type >.

Referenced by Stochastic< CloudType >::calculate().

Here is the caller graph for this function:

virtual TypeGrad interpolateGrad	(	const point	position,
		const tetIndices &	tetIs
	)		const

pure virtual

Interpolate gradient.

Implemented in Dual< Type >, Moment< Type >, and Basic< Type >.

void average ( )

virtual

Calculate the average.

Reimplemented in Dual< Type >.

Definition at line 121 of file AveragingMethod.C.

Referenced by Stochastic< CloudType >::calculate(), and MPPICParcel< ParcelType >::TrackingData< CloudType >::updateAverages().

Here is the caller graph for this function:

void average ( const AveragingMethod< scalar > & weight )

virtual

Reimplemented in Dual< Type >.

Definition at line 129 of file AveragingMethod.C.

References Foam::max().

Here is the call graph for this function:

bool writeData ( Ostream & os ) const

virtual

Dummy write.

Implements regIOobject.

Definition at line 140 of file AveragingMethod.C.

References IOstream::good().

Here is the call graph for this function:

bool write ( ) const

virtual

Write using setting from DB.

Reimplemented from regIOobject.

Definition at line 147 of file AveragingMethod.C.

References Foam::dimless, f(), tetIndices::face(), tetIndices::faceBasePt(), tetIndices::facePtA(), tetIndices::facePtB(), forAll, Foam::MULES::interpolate(), tetrahedron< Point, PointRef >::mag(), Foam::name(), GeometricField< Type, PatchField, GeoMesh >::primitiveFieldRef(), tetIndices::tet(), timeName, regIOobject::write(), and Foam::Zero.

Here is the call graph for this function:

virtual tmp<Field<Type> > primitiveField ( ) const

pure virtual

Return an internal field of the average.

Implemented in Dual< Type >, Moment< Type >, and Basic< Type >.

Referenced by Implicit< CloudType >::cacheFields().

Here is the caller graph for this function:

void operator= ( const AveragingMethod< Type > & x )

inline

Assign to another average.

Definition at line 30 of file AveragingMethodI.H.

References x.

void operator= ( const Type & x )

inline

Assign to value.

Definition at line 41 of file AveragingMethodI.H.

References x.

void operator= ( tmp< FieldField< Field, Type >> x )

inline

Assign to tmp.

Definition at line 52 of file AveragingMethodI.H.

References x.

void operator+= ( tmp< FieldField< Field, Type >> x )

inline

Add-equal tmp.

Definition at line 63 of file AveragingMethodI.H.

References x.

void operator*= ( tmp< FieldField< Field, Type >> x )

inline

Multiply-equal tmp.

Definition at line 74 of file AveragingMethodI.H.

References x.

void operator/= ( tmp< FieldField< Field, scalar >> x )

inline

Divide-equal tmp.

Definition at line 85 of file AveragingMethodI.H.

References x.

Member Data Documentation

const dictionary& dict_

protected

Protected data.

Dictionary

Definition at line 68 of file AveragingMethod.H.

const fvMesh& mesh_

protected

The mesh on which the averaging is to be done.

Definition at line 71 of file AveragingMethod.H.

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

src/lagrangian/intermediate/parcels/Templates/MPPICParcel/MPPICParcel.H
src/lagrangian/intermediate/submodels/MPPIC/AveragingMethods/AveragingMethod/AveragingMethod.H
src/lagrangian/intermediate/submodels/MPPIC/AveragingMethods/AveragingMethod/AveragingMethod.C
src/lagrangian/intermediate/submodels/MPPIC/AveragingMethods/AveragingMethod/AveragingMethodI.H

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

template<class Type> class Foam::AveragingMethod< Type >

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

template<class Type>
class Foam::AveragingMethod< Type >