Base class for lagrangian averaging methods. More...

#include <AveragingMethod.H>

Inheritance diagram for AveragingMethod< Type >:

[legend]

Collaboration diagram for AveragingMethod< Type >:

[legend]

Public Member Functions
	TypeName ("averagingMethod")
	Runtime type information.
	declareRunTimeSelectionTable (autoPtr, AveragingMethod, dictionary,(const IOobject &io, const dictionary &dict, const fvMesh &mesh),(io, dict, mesh))
	Declare runtime constructor selection table.
	AveragingMethod (const IOobject &io, const dictionary &dict, const fvMesh &mesh, const labelList &size)
	Constructors.
	AveragingMethod (const AveragingMethod< Type > &am)
	Construct a copy.
virtual autoPtr< AveragingMethod< Type > >	clone () const =0
	Construct and return a clone.
virtual	~AveragingMethod ()=default
	Destructor.
virtual void	add (const barycentric &coordinates, const tetIndices &tetIs, const Type &value)=0
	Member Functions.
virtual Type	interpolate (const barycentric &coordinates, const tetIndices &tetIs) const =0
	Interpolate.
virtual TypeGrad	interpolateGrad (const barycentric &coordinates, const tetIndices &tetIs) const =0
	Interpolate gradient.
virtual void	average ()
	Calculate the average.
virtual void	average (const AveragingMethod< scalar > &weight)
virtual bool	writeData (Ostream &) const
	Dummy write.
virtual bool	write (const bool writeOnProc=true) const
	Write using setting from DB.
virtual tmp< Field< Type > >	primitiveField () const =0
	Return an internal field of the average.
void	operator= (const AveragingMethod< Type > &x)
	Assign to another average.
void	operator= (const Type &x)
	Assign to value.
void	operator= (tmp< FieldField< Field, Type > > x)
	Assign to tmp.
void	operator+= (tmp< FieldField< Field, Type > > x)
	Add-equal tmp.
void	operator*= (tmp< FieldField< Field, Type > > x)
	Multiply-equal tmp.
void	operator/= (tmp< FieldField< Field, scalar > > x)
	Divide-equal tmp.
Public Member Functions inherited from regIOobject
void	operator= (const regIOobject &)=delete
	No copy assignment.
	TypeName ("regIOobject")
	Runtime type information.
	regIOobject (const IOobject &io, const bool isTimeObject=false)
	Construct from IOobject. The optional flag adds special handling if the object is the top-level regIOobject (eg, Time).
	regIOobject (const regIOobject &rio)
	Copy construct.
	regIOobject (const regIOobject &rio, bool registerCopy)
	Copy construct, transferring registry registration to the copy if registerCopy is true.
	regIOobject (const word &newName, const regIOobject &, bool registerCopy)
	Copy construct with new name, transferring registry registration to the copy if registerCopy is true.
	regIOobject (const IOobject &io, const regIOobject &rio)
	Copy construct with new IO parameters.
virtual	~regIOobject ()
	Destructor.
bool	checkIn ()
	Add object to registry, if not already registered.
bool	checkOut ()
	Remove object from registry, and remove all file watches.
virtual void	addWatch ()
	Add file watch on object (if registered and READ_IF_MODIFIED).
bool	registered () const noexcept
	Query the registered state (ie, has been checked in). This is not necessarily the same as registerObject(), which is just a stated preference.
bool	ownedByRegistry () const noexcept
	Is this object owned by the registry?
bool	store ()
	Register object with its registry and transfer ownership to the registry.
void	release (const bool unregister=false) noexcept
	Set object as not ownedByRegistry.
label	eventNo () const noexcept
	Event number at last update.
label &	eventNo () noexcept
	Event number at last update.
bool	upToDate (const regIOobject &) const
	Return true if up-to-date with respect to given object.
bool	upToDate (const regIOobject &, const regIOobject &) const
	Return true if up-to-date with respect to given objects.
bool	upToDate (const regIOobject &, const regIOobject &, const regIOobject &) const
	Return true if up-to-date with respect to given objects.
bool	upToDate (const regIOobject &, const regIOobject &, const regIOobject &, const regIOobject &) const
	Return true if up-to-date with respect to given objects.
void	setUpToDate ()
	Set as up-to-date.
virtual void	rename (const word &newName)
	Rename.
const dictionary *	findMetaData () const noexcept
	Return pointer to meta-data or nullptr.
dictionary &	getMetaData () noexcept
	Get or create meta-data.
void	removeMetaData ()
	Remove meta-data.
virtual void	updateMetaData ()
	Update internal meta-data (eg, prior to writing).
virtual fileName	filePath () const
	Return complete path + object name if the file exists.
bool	headerOk ()
	Read and check header info. Does not check the headerClassName.
Istream &	readStream (const word &, const bool readOnProc=true)
	Return Istream and check object type against that given.
void	close ()
	Close Istream.
virtual bool	readData (Istream &)
	Virtual readData function.
virtual bool	read ()
	Read object.
virtual label	addWatch (const fileName &)
	Add file watch for fileName on object if not yet watched.
const labelList &	watchIndices () const noexcept
	Read access to file-monitoring handles.
labelList &	watchIndices () noexcept
	Write access to file-monitoring handles.
virtual bool	modified () const
	Return true if the object's file (or files for objectRegistry) have been modified. (modified state is cached by Time).
virtual bool	readIfModified ()
	Read object if modified (as set by call to modified).
virtual bool	writeObject (IOstreamOption streamOpt, const bool writeOnProc) const
	Write using stream options.
virtual bool	global () const
	Is object global.
void	operator= (const IOobject &io)
	Copy assignment.
virtual bool	writeObject (IOstreamOption::streamFormat fmt, IOstreamOption::versionNumber ver, IOstreamOption::compressionType cmp, const bool writeOnProc) const
	Write using given format, version and compression.
Public Member Functions inherited from IOobject
	TypeName ("IOobject")
	Declare type-name, virtual type (with debug switch).
	IOobject (const IOobject &)=default
	Copy construct.
virtual	~IOobject ()=default
	Destructor.
	IOobject (const word &name, const fileName &instance, const objectRegistry &registry, IOobjectOption ioOpt=IOobjectOption())
	Construct from name, instance, registry, io options.
	IOobject (const word &name, const fileName &instance, const fileName &local, const objectRegistry &registry, IOobjectOption ioOpt=IOobjectOption())
	Construct from name, instance, local, registry, io options.
	IOobject (const fileName &path, const objectRegistry &registry, IOobjectOption ioOpt=IOobjectOption())
	Construct from path, registry, io options.
	IOobject (const word &name, const fileName &instance, const objectRegistry &registry, IOobjectOption::readOption rOpt, IOobjectOption::writeOption wOpt=IOobjectOption::NO_WRITE, bool registerObject=true, bool globalObject=false)
	Construct from name, instance, registry, io options.
	IOobject (const word &name, const fileName &instance, const fileName &local, const objectRegistry &registry, IOobjectOption::readOption rOpt, IOobjectOption::writeOption wOpt=IOobjectOption::NO_WRITE, bool registerObject=true, bool globalObject=false)
	Construct from name, instance, local, registry, io options.
	IOobject (const fileName &path, const objectRegistry &registry, IOobjectOption::readOption rOpt, IOobjectOption::writeOption wOpt=IOobjectOption::NO_WRITE, bool registerObject=true, bool globalObject=false)
	Construct from path, registry, io options.
	IOobject (const IOobject &io, const objectRegistry &registry)
	Copy construct, resetting registry.
	IOobject (const IOobject &io, const word &name)
	Copy construct, resetting name.
	IOobject (const IOobject &io, const word &name, const fileName &local)
	Copy construct, resetting name and local component.
	IOobject (const IOobject &io, IOobjectOption::readOption rOpt, IOobjectOption::writeOption wOpt)
	Copy construct, resetting read/write options.
	IOobject (const IOobject &io, IOobjectOption::registerOption regOpt)
	Copy construct, resetting register option.
autoPtr< IOobject >	clone () const
	Clone.
autoPtr< IOobject >	clone (const objectRegistry &registry) const
	Clone resetting registry.
const objectRegistry &	db () const noexcept
	Return the local objectRegistry.
const Time &	time () const noexcept
	Return Time associated with the objectRegistry.
const word &	name () const noexcept
	Return the object name.
const word &	headerClassName () const noexcept
	Return name of the class name read from header.
word &	headerClassName () noexcept
	Modifiable access to the class name read from header.
const string &	note () const noexcept
	Return the optional note.
string &	note () noexcept
	Modifiable access to the optional note.
unsigned	labelByteSize () const noexcept
	The sizeof (label) in bytes, possibly read from the header.
unsigned	scalarByteSize () const noexcept
	The sizeof (scalar) in bytes, possibly read from the header.
void	resetHeader (const word &newName=word::null)
	Clear various bits (headerClassName, note, sizeof...) that would be obtained when reading from a file.
bool	hasHeaderClass () const noexcept
	True if headerClassName() is non-empty (after reading).
bool	isHeaderClass (const word &expectedType) const
	Check if headerClassName() equals the expected type. Always true if the expected type is empty.
template<class Type>
bool	isHeaderClass () const
	Check if headerClassName() equals Type::typeName Always true for a `void` type.
word	group () const
	Return group (extension part of name).
word	member () const
	Return member (name without the extension).
const fileName &	rootPath () const noexcept
	Return the Time::rootPath().
const fileName &	caseName () const noexcept
	Return the Time::caseName().
const fileName &	globalCaseName () const noexcept
	Return the Time::globalCaseName().
const fileName &	caseName (IOobjectOption::Layout) const noexcept
	Return the Time::caseName() - normal or global.
const fileName &	instance () const noexcept
	Read access to instance path component.
fileName &	instance () noexcept
	Modifiable access to instance path component.
scalar	instanceValue () const
	Return the scalar value of the instance component (or 0), which often corresponds to a time index/value.
const fileName &	local () const noexcept
	Read access to local path component.
fileName &	local () noexcept
	Modifiable access to the local path component.
fileName	path () const
	The complete path for the object (with instance, local,...).
fileName	globalPath () const
	The complete global path for the object (with instance, local,...).
fileName	path (IOobjectOption::Layout) const
	The complete path (normal or global) for the object.
fileName	path (const word &instance, const fileName &local=fileName::null) const
	The complete path with alternative instance and local.
fileName	globalPath (const word &instance, const fileName &local=fileName::null) const
	The complete global path with alternative instance and local.
fileName	path (IOobjectOption::Layout, const word &instance, const fileName &local=fileName::null) const
	The complete path (normal or global) with alternative instance and local.
fileName	objectPath () const
	The complete path + object name.
fileName	globalObjectPath () const
	The complete global path + object name.
fileName	objectPath (IOobjectOption::Layout) const
	The complete path (normal or global) + object name.
fileName	objectPath (IOobjectOption::Layout, const word &instance) const
	The complete path (normal or global) + object name with alternative instance.
fileName	objectPath (const word &instance) const
	The complete path + object name with alternative instance.
fileName	globalObjectPath (const word &instance) const
	The complete global path + object name with alternative instance.
fileName	objectRelPath () const
	The object path relative to the case.
fileName	localFilePath (const word &typeName, const bool search=true) const
	Redirect to fileHandler filePath, searching locally.
fileName	globalFilePath (const word &typeName, const bool search=true) const
	Redirect to fileHandler filePath, searching up if in parallel.
IOstreamOption	parseHeader (const dictionary &headerDict)
	Parse 'FoamFile' header contents and set the IOobject characteristics and return the stream characteristics.
bool	readHeader (Istream &is)
	Read header ('FoamFile' dictionary) and set the IOobject and stream characteristics.
bool	readHeader (dictionary &headerDict, Istream &is)
	Read header (the 'FoamFile' dictionary) and set the IOobject and stream characteristics.
template<class Type>
bool	typeHeaderOk (const bool checkType=true, const bool search=true, const bool verbose=true)
	Read header (respects is_globalIOobject trait) and check its info. A `void` type suppresses trait and type-name checks.
template<class Type, bool Searching>
bool	typeHeaderOk (const bool checkType=true, const bool verbose=true)
	Forwards to single-parameter version with the specified search type. A `void` type suppresses trait and type-name checks.
template<class Type>
fileName	typeFilePath (const bool search=true) const
	Call localFilePath or globalFilePath for given type depending on its is_globalIOobject trait.
template<class Type>
void	warnNoRereading () const
	Helper: warn that type does not support re-reading.
bool	writeHeader (Ostream &os) const
	Write header with current type().
bool	writeHeader (Ostream &os, const word &objectType) const
	Write header with override of type.
void	writeHeader (dictionary &dict, IOstreamOption streamOpt) const
	Write header into a dictionary with current type() and given output format.
void	writeHeader (dictionary &dict, const word &objectType, IOstreamOption streamOpt) const
	Write header into a dictionary with override of type and given output format.
bool	good () const noexcept
	Did last readHeader() succeed?
bool	bad () const noexcept
	Did last readHeader() fail?
InfoProxy< IOobject >	info () const noexcept
	Return info proxy, for printing information to a stream.
void	operator= (const IOobject &io)
	Copy assignment, copies all values (except the registry).
template<class Type>
bool	isHeaderClassName () const
	Same as isHeaderClass().
template<class StringType>
Foam::word	groupName (StringType base, const word &group)
template<class Type>
Foam::fileName	typeFilePath (const bool search) const
Public Member Functions inherited from IOobjectOption
constexpr	IOobjectOption (readOption rOpt=readOption::NO_READ, writeOption wOpt=writeOption::NO_WRITE, registerOption registerObject=registerOption::REGISTER, bool globalObject=false) noexcept
	Default construct (NO_READ, NO_WRITE, REGISTER, non-global) or construct with specified options.
constexpr	IOobjectOption (readOption rOpt, registerOption registerObject=registerOption::REGISTER, bool globalObject=false) noexcept
	Construct NO_WRITE with specified read/register options.
constexpr	IOobjectOption (writeOption wOpt, registerOption registerObject=registerOption::REGISTER, bool globalObject=false) noexcept
	Construct NO_READ with specified write/register options.
constexpr	IOobjectOption (registerOption registerObject, bool globalObject=false) noexcept
	Construct (NO_READ, NO_WRITE) with specified register option.
constexpr	IOobjectOption (readOption rOpt, writeOption wOpt, bool registerObject, bool globalObject=false) noexcept
	Construct from components with specified register option as bool.
constexpr	IOobjectOption (bool registerObject, bool globalObject=false) noexcept
	Construct (NO_READ, NO_WRITE) with specified register option as bool.
readOption	readOpt () const noexcept
	Get the read option.
readOption	readOpt (readOption opt) noexcept
	Set the read option.
writeOption	writeOpt () const noexcept
	Get the write option.
writeOption	writeOpt (writeOption opt) noexcept
	Set the write option.
bool	registerObject () const noexcept
	Should objects created with this IOobject be registered?
bool	registerObject (bool on) noexcept
	Change registration preference.
bool	globalObject () const noexcept
	True if object is treated the same for all processors.
bool	globalObject (bool on) noexcept
	Change global-object status.
bool	isAnyRead () const noexcept
	True if any reading may be required (ie, != NO_READ).
bool	isReadRequired () const noexcept
	True if (MUST_READ \| READ_MODIFIED) bits are set.
bool	isReadOptional () const noexcept
	True if (LAZY_READ) bits are set [same as READ_IF_PRESENT].
readOption &	readOpt () noexcept
	Access to the read option.
writeOption &	writeOpt () noexcept
	Access to the write option.
bool &	registerObject () noexcept
	Access to the register object option.
bool &	globalObject () noexcept
	Access to the global object option.
Public Member Functions inherited from FieldField< Field, Type >
constexpr	FieldField () noexcept
	Construct null.
	FieldField (const label size)
	Construct given size.
	FieldField (const word &type, const FieldField< Field, Type > &ff)
	Clone construct with new type.
	FieldField (const FieldField< Field, Type > &ff)
	Copy construct, cloning each element.
	FieldField (FieldField< Field, Type > &&ff)
	Move construct.
	FieldField (FieldField< Field, Type > &ff, bool reuse)
	Construct as copy or re-use as specified.
	FieldField (const PtrList< Field< Type > > &list)
	Copy construct from PtrList.
	FieldField (PtrList< Field< Type > > &&list)
	Move construct from PtrList.
	FieldField (const tmp< FieldField< Field, Type > > &tf)
	Move/copy construct from tmp<FieldField>.
	FieldField (Istream &is)
	Construct from Istream.
tmp< FieldField< Field, Type > >	clone () const
	Clone.
void	negate ()
	Negate this field. See notes in Field.
void	normalise ()
	Normalise this field. See notes in Field.
tmp< FieldField< Field, cmptType > >	component (const direction) const
	Return a component field of the field.
void	replace (const direction, const FieldField< Field, cmptType > &)
	Replace a component field of the field.
void	replace (const direction, const cmptType &)
	Replace a component field of the field.
void	clamp_min (const Type &lower)
	Impose lower (floor) clamp on the field values (in-place).
void	clamp_min (const FieldField< Field, Type > &lower)
	Impose lower (floor) clamp on the field values (in-place).
void	clamp_max (const Type &upper)
	Impose upper (ceiling) clamp on the field values (in-place).
void	clamp_max (const FieldField< Field, Type > &upper)
	Impose upper (ceiling) clamp on the field values (in-place).
void	clamp_range (const Type &lower, const Type &upper)
	Clamp field values (in-place) to the specified range.
void	clamp_range (const MinMax< Type > &range)
	Clamp field values (in-place) to the specified range.
tmp< FieldField< Field, Type > >	T () const
	Return the field transpose (only defined for second rank tensors).
const Type &	operator[] (const labelPair &index) const
	Const access to a single field element via (fieldi, elemi).
Type &	operator[] (const labelPair &index)
	Non-const access to a single field element via (fieldi, elemi).
void	operator= (const FieldField< Field, Type > &)
	Copy assignment.
void	operator= (FieldField< Field, Type > &&)
	Move assignment.
void	operator= (const tmp< FieldField< Field, Type > > &)
	Move or clone assignment.
void	operator= (const Type &val)
	Assign uniform value.
void	operator= (Foam::zero)
	Assign uniform zero.
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
constexpr	refCount () noexcept
	Default construct, initializing count to 0.
int	use_count () const noexcept
	Return the current reference count.
bool	unique () const noexcept
	Return true if the reference count is zero.
void	operator++ () noexcept
	Increment the reference count.
void	operator++ (int) noexcept
	Increment the reference count.
void	operator-- () noexcept
	Decrement the reference count.
void	operator-- (int) noexcept
	Decrement the reference count.
Public Member Functions inherited from PtrList< Field< Type > >
Foam::PtrList< Field< Type > >	clone (Args &&... args) const
constexpr	PtrList () noexcept
	Default construct.
	~PtrList ()
	Destructor. Frees all pointers.
const Field< Type > *	set (const label i) const
	Return const pointer to element (can be nullptr), or nullptr for out-of-range access (ie, with bounds checking).
void	clear ()
	Clear the PtrList. Delete allocated entries and set size to zero.
void	free ()
	Free memory and nullify all entries. Does not change the list size.
void	resize (const label newLen)
	Adjust size of PtrList.
void	resize_null (const label newLen)
	Set the addressed list to the given size, deleting all existing entries. Afterwards the list contains all `nullptr` entries.
Field< Type > &	emplace_back (Args &&... args)
	Construct and append an element to the end of the list, return reference to the new list element.
void	push_back (Field< Type > *ptr)
	Append an element to the end of the list.
Field< Type > &	emplace_set (const label i, Args &&... args)
	Construct and set a new element at given position, (discard old element at that location).
Field< Type > &	emplace (const label i, Args &&... args)
	Same as emplace_set().
Field< Type > &	try_emplace (const label i, Args &&... args)
	Like emplace_set() but will not overwrite an occupied (non-null) location.
autoPtr< Field< Type > >	release (const label i)
	Release ownership of the pointer at the given position.
void	transfer (PtrList< Field< Type > > &list)
	Transfer into this list and annul the argument list.
void	operator= (const UPtrList< Field< Type > > &list)
	Copy assignment.
void	setSize (const label n)
	Same as resize().
void	append (autoPtr< Field< Type > > &ptr)
	Move append an element to the end of the list.
Public Member Functions inherited from UPtrList< Field< Type > >
bool	empty () const noexcept
	True if the list is empty (ie, size() is zero).
label	size () const noexcept
	The number of entries in the list.
label	capacity () const noexcept
	Size of the underlying storage.
label	count_nonnull () const noexcept
	The number of non-nullptr entries in the list.
Field< Type > &	front ()
	Reference to the first element of the list.
Field< Type > &	back ()
	Reference to the last element of the list.
const Field< Type > *	test (const label i) const
	Return const pointer to element (can be nullptr), or nullptr for out-of-range access (ie, with bounds checking).
const Field< Type > *	get (const label i) const
	Return const pointer to element (can be nullptr), or nullptr for out-of-range access (ie, with bounds checking).
const Field< Type > *	set (const label i) const
	Return const pointer to element (can be nullptr), or nullptr for out-of-range access (ie, with bounds checking).
void	clear ()
	Set list size to zero.
void	free ()
	Nullify all entries. Does not change the list size.
void	resize (const label newLen)
	Change the size of the list. Any new entries are `nullptr`.
void	resize_null (const label newLen)
	Set the list to the given size and set all entries to `nullptr`.
label	squeezeNull ()
	Squeeze out nullptr entries in the list of pointers after which any null pointers will be at the end of the list.
void	push_back (Field< Type > *ptr)
	Append an element to the end of the list.
void	swap (UPtrList< Field< Type > > &list) noexcept
	Swap content.
void	transfer (UPtrList< Field< Type > > &list)
	Transfer contents into this list and annul the argument.
void	reorder (const labelUList &oldToNew, const bool check=false)
	Reorder elements. Reordering must be unique (ie, shuffle).
void	sortOrder (const labelUList &order, const bool check=false)
	Reorder elements according to new order mapping (newToOld). Reordering must be unique (ie, shuffle).
void	checkNonNull () const
	Check and raise FatalError if any nullptr exists in the list.
const Field< Type > &	at (const label i) const
	Return const reference to the element at given position. FatalError for bounds problem or nullptr.
const Field< Type > &	operator[] (const label i) const
	Return const reference to the element at given position. FatalError for bounds problem or nullptr. Same as at().
	FOAM_DEPRECATED_FOR (2022-09, "get(), set() or test() methods") const Field< Type > *operator()(const label i) const
	Deprecated(2022-09) - same as get().
void	operator= (const UPtrList< Field< Type > > &list)
	Copy assignment (shallow copies addresses).
Ostream &	printAddresses (Ostream &os) const
	Print pointer addresses to Ostream (debugging only).
Ostream &	writeList (Ostream &os, const bool trimNull=false) const
	Write UPtrList to Ostream, optionally ignoring null entries.
Field< Type > **	begin_ptr () noexcept
	Iterator to begin of raw pointers traversal (use with caution).
Field< Type > **	end_ptr () noexcept
	Iterator beyond end of raw pointers traversal (use with caution).
iterator	begin ()
	Return iterator to begin traversal of non-nullptr entries.
iterator	end () noexcept
	Return iterator beyond end of UPtrList traversal.
const_iterator	cbegin () const
	Return const_iterator to begin traversal of non-nullptr entries.
const_iterator	cend () const noexcept
	Return const_iterator beyond end of UPtrList traversal.
void	setSize (const label n)
	Alias for resize().
Field< Type > &	first ()
	Reference to the first element of the list.
Field< Type > &	last ()
	Return reference to the last element of the list.
void	append (Field< Type > *ptr)
	Append an element to the end of the list.
label	count () const noexcept
	The number of non-nullptr entries in the list.

Static Public Member Functions
static autoPtr< AveragingMethod< Type > >	New (const IOobject &io, const dictionary &dict, const fvMesh &mesh)
	Selector.
Static Public Member Functions inherited from regIOobject
template<class Type>
static Type &	store (Type *p)
	Transfer pointer ownership to its registry.
template<class Type>
static Type &	store (std::unique_ptr< Type > &&ptr)
	Transfer pointer ownership to its registry.
template<class Type>
static Type &	store (autoPtr< Type > &ptr)
	Transfer pointer ownership to its registry.
template<class Type>
static Type &	store (autoPtr< Type > &&ptr)
	Transfer pointer ownership to its registry.
template<class Type>
static Type &	store (refPtr< Type > &ptr)
	Transfer pointer ownership to its registry.
template<class Type>
static Type &	store (refPtr< Type > &&ptr)
	Transfer pointer ownership to its registry.
template<class Type>
static Type &	store (tmp< Type > &ptr)
	Transfer pointer ownership to its registry.
template<class Type>
static Type &	store (tmp< Type > &&ptr)
	Transfer pointer ownership to its registry.
Static Public Member Functions inherited from IOobject
static bool	bannerEnabled () noexcept
	Status of output file banner.
static bool	bannerEnabled (bool on) noexcept
	Enable/disable output file banner.
static bool	fileModificationChecking_masterOnly () noexcept
	Test fileModificationChecking for master-only.
static bool	fileNameComponents (const fileName &path, fileName &instance, fileName &local, word &name)
	Split path into instance, local, name components.
template<class StringType>
static word	groupName (StringType base, const word &group)
	Create dot-delimited name.group string.
static word	group (const word &name)
	Return group (extension part of name).
static word	member (const word &name)
	Return member (name without the extension).
static word	scopedName (const std::string &scope, const word &name)
	Create scope:name or scope_name string.
static word	scopedName (const std::string &scope, const word &name1, const word &name2)
	Create scope:name1:name2 or scope_name1_name2 string.
static IOobject	selectIO (const IOobject &io, const fileName &altFile, const word &ioName="")
	Return the IOobject, but also consider an alternative file name.
static Ostream &	writeBanner (Ostream &os, const bool noSyntaxHint=false)
	Write the standard OpenFOAM file/dictionary banner.
static Ostream &	writeDivider (Ostream &os)
	Write the standard file section divider.
static Ostream &	writeEndDivider (Ostream &os)
	Write the standard end file divider.
Static Public Member Functions inherited from IOobjectOption
static bool	isAnyRead (readOption opt) noexcept
	True if any reading may be required (ie, != NO_READ).
static bool	isReadRequired (readOption opt) noexcept
	True if (MUST_READ \| READ_MODIFIED) bits are set.
static bool	isReadOptional (readOption opt) noexcept
	True if (LAZY_READ) bits are set [same as READ_IF_PRESENT].
static readOption	lazierRead (readOption opt) noexcept
	Downgrade readOption optional (LAZY_READ), leaves NO_READ intact.
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.

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

Protected Member Functions
virtual void	updateGrad ()
	Protected member functions.
Protected Member Functions inherited from regIOobject
bool	readHeaderOk (const IOstreamOption::streamFormat fmt, const word &typeName)
	Helper: check readOpt flags and read if necessary.
Protected Member Functions inherited from IOobject
void	setBad (const string &s)
	Set the object state to bad.
Protected Member Functions inherited from PtrList< Field< Type > >
void	readIstream (Istream &is, const INew &inew)
	Read from Istream using Istream constructor class.
Protected Member Functions inherited from UPtrList< Field< Type > >
void	setAddressableSize (const label n) noexcept
	Adjust addressable size.
label	find_next (label pos) const
	The next non-null entry after the specified position.
	UPtrList (Detail::PtrListDetail< Field< Type > > &&ptrs) noexcept
	Low-level move construct.

Protected Attributes
const dictionary &	dict_
	Protected data.
const fvMesh &	mesh_
	The mesh on which the averaging is to be done.
Protected Attributes inherited from UPtrList< Field< Type > >
Detail::PtrListDetail< Field< Type > >	ptrs_
	The list of pointers.

Additional Inherited Members
Public Types inherited from IOobject
enum	objectState : char { GOOD , BAD }
	Enumeration defining the valid states of an IOobject. More...
enum	fileCheckTypes : char { timeStamp = 1 , timeStampMaster = 3 , inotify = 4 , inotifyMaster = 6 }
	Enumeration defining the file checking options (time-stamp \| inotify) \| (all \| masterOnly). More...
Public Types inherited from IOobjectOption
enum	readOption : unsigned char { NO_READ = 0 , MUST_READ = 0x1 , READ_MODIFIED = 0x3 , MUST_READ_IF_MODIFIED = 0x3 , LAZY_READ = 0x4 , READ_IF_PRESENT = 0x4 }
	Enumeration defining read preferences. More...
enum	writeOption : unsigned char { NO_WRITE = 0 , AUTO_WRITE = 0x10 }
	Enumeration defining write preferences. More...
enum	registerOption : unsigned char { NO_REGISTER = 0 , REGISTER = 1 , LEGACY_REGISTER = 2 }
	Enumeration for use with registerObject(). Values map to bool (false/true). More...
enum class	Layout : unsigned char { regular , global }
	The layout of the case structure. More...
Public Types inherited from FieldField< Field, Type >
typedef pTraits< Type >::cmptType	cmptType
	Component type.
Public Types inherited from UPtrList< Field< Type > >
typedef Field< Type >	value_type
	Type of values the list contains.
typedef Field< Type > &	reference
	A non-const reference to the value_type.
typedef const Field< Type > &	const_reference
	A const reference to the value_type.
Static Public Attributes inherited from IOobject
static const Enum< fileCheckTypes >	fileCheckTypesNames
	Names for the fileCheckTypes.
static char	scopeSeparator
	Character for scoping object names (':' or '_').
static fileCheckTypes	fileModificationChecking
	Type of file modification checking.
static float	fileModificationSkew
	Time skew (seconds) for file modification checks.
static int	maxFileModificationPolls
	Max number of times to poll for file modification changes.
Static Protected Member Functions inherited from IOobject
static void	writeHeaderContent (Ostream &os, const IOobject &io, const word &objectType, const dictionary *metaDataDict=nullptr)
	Helper: write content for FoamFile IOobject header with optional meta information.
static void	writeHeaderContent (dictionary &dict, const IOobject &io, const word &objectType, IOstreamOption streamOpt, const dictionary *metaDataDict=nullptr)
	Helper: write dictionary content for FoamFile header with optional meta information.
Static Protected Attributes inherited from regIOobject
static bool	masterOnlyReading = false
	To flag master-only reading of objects.

Detailed Description

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

Base class for lagrangian averaging methods.

Source files

Definition at line 54 of file AveragingMethod.H.

Member Typedef Documentation

◆ TypeGrad

template<class Type>

typedef outerProduct<vector,Type>::type TypeGrad

protected

Protected typedefs.

Gradient type

Definition at line 68 of file AveragingMethod.H.

Constructor & Destructor Documentation

◆ AveragingMethod() [1/2]

template<class Type>

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

Constructors.

Construct from components

Definition at line 36 of file AveragingMethod.C.

References UPtrList< Field< Type > >::append(), dict, dict_, FieldField< Field, Type >::FieldField(), forAll, io, mesh, mesh_, regIOobject::regIOobject(), UPtrList< Field< Type > >::size(), and Foam::Zero.

Referenced by average(), Dual< Type >::average(), AveragingMethod(), Basic< Type >::Basic(), Basic< Type >::Basic(), Dual< Type >::Dual(), Dual< Type >::Dual(), Moment< Type >::Moment(), Moment< Type >::Moment(), operator=(), and Dual< Type >::~Dual().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ AveragingMethod() [2/2]

template<class Type>

AveragingMethod ( const AveragingMethod< Type > & am )

Construct a copy.

Definition at line 60 of file AveragingMethod.C.

References AveragingMethod(), dict_, FieldField< Field, Type >::FieldField(), mesh_, and regIOobject::regIOobject().

Here is the call graph for this function:

◆ ~AveragingMethod()

template<class Type>

virtual ~AveragingMethod ( )

virtualdefault

Destructor.

Member Function Documentation

◆ updateGrad()

template<class Type>

void updateGrad ( )

protectedvirtual

Protected member functions.

Update the gradient calculation

Definition at line 29 of file AveragingMethod.C.

Referenced by average(), average(), operator*=(), operator+=(), operator/=(), operator=(), operator=(), and operator=().

Here is the caller graph for this function:

◆ TypeName()

template<class Type>

TypeName ( "averagingMethod" )

Runtime type information.

◆ declareRunTimeSelectionTable()

template<class Type>

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

Declare runtime constructor selection table.

◆ clone()

template<class Type>

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

pure virtual

Construct and return a clone.

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

◆ New()

template<class Type>

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

static

Selector.

Definition at line 76 of file AveragingMethod.C.

References dict, FatalIOErrorInLookup, Foam::GlobalIOList< Tuple2< scalar, vector > >::typeName, io, and mesh.

Referenced by Relaxation< CloudType >::cacheFields(), Explicit< CloudType >::cacheFields(), Stochastic< CloudType >::calculate(), KinematicParcel< ParcelType >::trackingData::updateAverages(), and MPPICParcel< ParcelType >::trackingData::updateAverages().

Here is the caller graph for this function:

◆ add()

template<class Type>

virtual void add	(	const barycentric &	coordinates,
		const tetIndices &	tetIs,
		const Type &	value )

pure virtual

Member Functions.

Add point value to interpolation

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

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

Here is the caller graph for this function:

◆ interpolate()

template<class Type>

virtual Type interpolate	(	const barycentric &	coordinates,
		const tetIndices &	tetIs ) const

pure virtual

Interpolate.

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

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

Here is the caller graph for this function:

◆ interpolateGrad()

template<class Type>

virtual TypeGrad interpolateGrad	(	const barycentric &	coordinates,
		const tetIndices &	tetIs ) const

pure virtual

Interpolate gradient.

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

◆ average() [1/2]

template<class Type>

void average ( )

virtual

Calculate the average.

Reimplemented in Dual< Type >.

Definition at line 108 of file AveragingMethod.C.

References updateGrad().

Referenced by Dual< Type >::average(), Dual< Type >::average(), and Stochastic< CloudType >::calculate().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ average() [2/2]

template<class Type>

void average ( const AveragingMethod< scalar > & weight )

virtual

Reimplemented in Dual< Type >.

Definition at line 115 of file AveragingMethod.C.

References AveragingMethod(), Foam::max(), and updateGrad().

Here is the call graph for this function:

◆ writeData()

template<class Type>

bool writeData ( Ostream & os ) const

virtual

Dummy write.

Implements regIOobject.

Definition at line 127 of file AveragingMethod.C.

◆ write()

template<class Type>

bool write ( const bool writeOnProc = true ) const

virtual

Write using setting from DB.

Reimplemented from regIOobject.

Definition at line 134 of file AveragingMethod.C.

References Foam::dimless, mesh_, name, GeometricField< Type, PatchField, GeoMesh >::New(), IOobjectOption::NO_REGISTER, IOobject::scopedName(), and Foam::Zero.

Here is the call graph for this function:

◆ primitiveField()

template<class Type>

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

pure virtual

Return an internal field of the average.

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

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

Here is the caller graph for this function:

◆ operator=() [1/3]

template<class Type>

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

inline

Assign to another average.

Definition at line 24 of file AveragingMethodI.H.

References AveragingMethod(), FieldField< Field, Type >::operator, FieldField< Field, Type >::operator=(), updateGrad(), and x.

Here is the call graph for this function:

◆ operator=() [2/3]

template<class Type>

void operator= ( const Type & x )

inline

Assign to value.

Definition at line 35 of file AveragingMethodI.H.

References FieldField< Field, Type >::operator, FieldField< Field, Type >::operator=(), updateGrad(), and x.

Here is the call graph for this function:

◆ operator=() [3/3]

template<class Type>

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

inline

Assign to tmp.

Definition at line 46 of file AveragingMethodI.H.

References FieldField< Field, Type >::operator, FieldField< Field, Type >::operator=(), updateGrad(), and x.

Here is the call graph for this function:

◆ operator+=()

template<class Type>

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

inline

Add-equal tmp.

Definition at line 57 of file AveragingMethodI.H.

References FieldField< Field, Type >::operator, FieldField< Field, Type >::operator+=(), updateGrad(), and x.

Here is the call graph for this function:

◆ operator*=()

template<class Type>

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

inline

Multiply-equal tmp.

Definition at line 68 of file AveragingMethodI.H.

References FieldField< Field, Type >::operator, FieldField< Field, Type >::operator*=(), updateGrad(), and x.

Here is the call graph for this function:

◆ operator/=()

template<class Type>

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

inline

Divide-equal tmp.

Definition at line 79 of file AveragingMethodI.H.

References FieldField< Field, Type >::operator, FieldField< Field, Type >::operator/=(), updateGrad(), and x.

Here is the call graph for this function:

Member Data Documentation

◆ dict_

template<class Type>

const dictionary& dict_

protected

Protected data.

Dictionary

Definition at line 78 of file AveragingMethod.H.

Referenced by AveragingMethod(), and AveragingMethod().

◆ mesh_

template<class Type>

const fvMesh& mesh_

protected

The mesh on which the averaging is to be done.

Definition at line 83 of file AveragingMethod.H.

Referenced by Basic< Type >::add(), Moment< Type >::add(), AveragingMethod(), AveragingMethod(), Dual< Type >::Dual(), Moment< Type >::interpolate(), Dual< Type >::interpolateGrad(), and write().

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

src/lagrangian/intermediate/parcels/Templates/KinematicParcel/KinematicParcel.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

Member Typedef Documentation

◆ TypeGrad

Constructor & Destructor Documentation

◆ AveragingMethod() [1/2]

◆ AveragingMethod() [2/2]

◆ ~AveragingMethod()

Member Function Documentation

◆ updateGrad()

◆ TypeName()

◆ declareRunTimeSelectionTable()

◆ clone()

◆ New()

◆ add()

◆ interpolate()

◆ interpolateGrad()

◆ average() [1/2]

◆ average() [2/2]

◆ writeData()

◆ write()

◆ primitiveField()

◆ operator=() [1/3]

◆ operator=() [2/3]

◆ operator=() [3/3]

◆ operator+=()

◆ operator*=()

◆ operator/=()

Member Data Documentation

◆ dict_

◆ mesh_