div Class Reference

Computes the divergence of an input field. More...

Inheritance diagram for div:

Collaboration diagram for div:

Public Member Functions
	TypeName ("div")
	div (const word &name, const Time &runTime, const dictionary &dict)
	div (const div &)=delete
void	operator= (const div &)=delete
virtual	~div ()=default
virtual bool	write ()
Public Member Functions inherited from fieldExpression
	TypeName ("fieldExpression")
	fieldExpression (const word &name, const Time &runTime, const dictionary &dict, const word &fieldName=word::null, const word &resultName=word::null)
	fieldExpression (const fieldExpression &)=delete
void	operator= (const fieldExpression &)=delete
virtual	~fieldExpression ()=default
virtual bool	read (const dictionary &dict)
virtual bool	execute ()
virtual bool	clear ()
Public Member Functions inherited from fvMeshFunctionObject
	TypeName ("fvMeshFunctionObject")
	fvMeshFunctionObject (const word &name, const Time &runTime, const dictionary &dict)
	fvMeshFunctionObject (const word &name, const objectRegistry &obr, const dictionary &dict)
virtual	~fvMeshFunctionObject ()=default
Public Member Functions inherited from regionFunctionObject
	TypeName ("regionFunctionObject")
	regionFunctionObject (const word &name, const Time &runTime, const dictionary &dict)
	regionFunctionObject (const word &name, const objectRegistry &obr, const dictionary &dict)
virtual	~regionFunctionObject ()=default
template<class ObjectType >
const ObjectType *	lookupObjectPtr (const word &fieldName) const
template<class ObjectType >
ObjectType *	lookupObjectRefPtr (const word &fieldName) const
Public Member Functions inherited from stateFunctionObject
	stateFunctionObject (const word &name, const Time &runTime)
virtual	~stateFunctionObject ()=default
dictionary &	propertyDict ()
bool	foundProperty (const word &entryName) const
void	clearTrigger ()
label	getTrigger () const
bool	setTrigger (const label triggeri, bool increaseOnly=true)
bool	getDict (const word &entryName, dictionary &dict) const
bool	getObjectDict (const word &objectName, const word &entryName, dictionary &dict) const
template<class Type >
Type	getProperty (const word &entryName, const Type &defaultValue=Type(Zero)) const
template<class Type >
bool	getProperty (const word &entryName, Type &value) const
template<class Type >
void	setProperty (const word &entryName, const Type &value)
template<class Type >
Type	getObjectProperty (const word &objectName, const word &entryName, const Type &defaultValue=Type(Zero)) const
template<class Type >
bool	getObjectProperty (const word &objectName, const word &entryName, Type &value) const
template<class Type >
void	setObjectProperty (const word &objectName, const word &entryName, const Type &value)
template<class Type >
void	setResult (const word &entryName, const Type &value)
template<class Type >
void	setObjectResult (const word &objectName, const word &entryName, const Type &value)
template<class Type >
Type	getResult (const word &entryName, const Type &defaultValue=Type(Zero)) const
template<class Type >
Type	getObjectResult (const word &objectName, const word &entryName, const Type &defaultValue=Type(Zero)) const
template<class Type >
bool	getObjectResult (const word &objectName, const word &entryName, Type &value) const
word	resultType (const word &entryName) const
word	objectResultType (const word &objectName, const word &entryName) const
wordList	objectResultEntries () const
wordList	objectResultEntries (const word &objectName) const
void	writeResultEntries (Ostream &os) const
void	writeResultEntries (const word &objectName, Ostream &os) const
void	writeAllResultEntries (Ostream &os) const
Public Member Functions inherited from timeFunctionObject
	timeFunctionObject (const word &name, const Time &runTime)
virtual	~timeFunctionObject ()=default
const Time &	time () const
objectRegistry &	storedObjects ()
const objectRegistry &	storedObjects () const
Public Member Functions inherited from functionObject
	declareRunTimeSelectionTable (autoPtr, functionObject, dictionary,(const word &name, const Time &runTime, const dictionary &dict),(name, runTime, dict))
	functionObject (const word &name, const bool withNamePrefix=defaultUseNamePrefix)
autoPtr< functionObject >	clone () const
virtual	~functionObject ()=default
virtual const word &	type () const =0
const word &	name () const noexcept
bool	useNamePrefix () const noexcept
bool	useNamePrefix (bool on) noexcept
virtual bool	execute (const label subIndex)
virtual bool	end ()
virtual bool	adjustTimeStep ()
virtual bool	filesModified () const
virtual void	updateMesh (const mapPolyMesh &mpm)
virtual void	movePoints (const polyMesh &mesh)

Additional Inherited Members
Static Public Member Functions inherited from functionObject
static autoPtr< functionObject >	New (const word &name, const Time &runTime, const dictionary &dict)
Public Attributes inherited from functionObject
bool	log
Static Public Attributes inherited from functionObject
static int	debug
static bool	postProcess
static bool	defaultUseNamePrefix
static word	outputPrefix
Protected Member Functions inherited from fieldExpression
void	setResultName (const word &typeName, const word &defaultArg)
template<class Type >
bool	foundObject (const word &name, const bool verbose=true) const
Protected Member Functions inherited from fvMeshFunctionObject
	fvMeshFunctionObject (const fvMeshFunctionObject &)=delete
void	operator= (const fvMeshFunctionObject &)=delete
Protected Member Functions inherited from regionFunctionObject
virtual const objectRegistry &	obr () const
template<class ObjectType >
bool	foundObject (const word &fieldName) const
template<class ObjectType >
const ObjectType *	cfindObject (const word &fieldName) const
template<class ObjectType >
const ObjectType *	findObject (const word &fieldName) const
template<class ObjectType >
ObjectType *	findObject (const word &fieldName)
template<class ObjectType >
ObjectType *	getObjectPtr (const word &fieldName) const
template<class ObjectType >
const ObjectType &	lookupObject (const word &fieldName) const
template<class ObjectType >
ObjectType &	lookupObjectRef (const word &fieldName) const
template<class ObjectType >
bool	store (word &fieldName, const tmp< ObjectType > &tfield, bool cacheable=false)
template<class ObjectType >
bool	storeInDb (const word &fieldName, const tmp< ObjectType > &tfield, const objectRegistry &obr)
bool	writeObject (const word &fieldName)
bool	clearObject (const word &fieldName)
void	clearObjects (const wordList &objNames)
	regionFunctionObject (const regionFunctionObject &)=delete
void	operator= (const regionFunctionObject &)=delete
Protected Member Functions inherited from stateFunctionObject
const functionObjects::properties &	stateDict () const
functionObjects::properties &	stateDict ()
	stateFunctionObject (const stateFunctionObject &)=delete
void	operator= (const stateFunctionObject &)=delete
Protected Member Functions inherited from timeFunctionObject
void	clearOutputObjects (const wordList &objNames)
	timeFunctionObject (const timeFunctionObject &)=delete
void	operator= (const timeFunctionObject &)=delete
Protected Member Functions inherited from functionObject
word	scopedName (const word &name) const
Protected Attributes inherited from fieldExpression
word	fieldName_
word	resultName_
autoPtr< Detail::zoneSubSet >	zoneSubSetPtr_
Protected Attributes inherited from fvMeshFunctionObject
const fvMesh &	mesh_
Protected Attributes inherited from regionFunctionObject
word	subRegistryName_
const objectRegistry &	obr_
const objectRegistry *	obrPtr_
Protected Attributes inherited from timeFunctionObject
const Time &	time_

Detailed Description

Computes the divergence of an input field.

Operands:

Operand	Type	Location
input	{surfaceScalar,volVector}Field	$FOAM_CASE/<time>/<inpField>
output file	-	-
output field	volScalarField	$FOAM_CASE/<time>/<outField>

Usage

Minimal example by using system/controlDict.functions:

div1
{
    // Mandatory entries (unmodifiable)
    type            div;
    libs            (fieldFunctionObjects);

    // Mandatory (inherited) entry (runtime modifiable)
    field           \<field\>;

    // Inherited entries
    ...
}

where the entries mean:

Property	Description	Type	Reqd	Deflt
type	Type name: div	word	yes	-
libs	Library name: fieldFunctionObjects	word	yes	-
field	Name of the operand field	word	yes	-

The inherited entries are elaborated in:

• functionObject.H
• fieldExpression.H
• zoneSubSet.H

Minimal example by using the postProcess utility:

        postProcess -func "div(\<field\>)"

Note

• To execute div function object on an input <field>, a numerical scheme should be defined for div(<field>) in system/fvSchemes.divSchemes.
• Optionally the user can specify cellZones to create a sub-mesh for the div calculation.

See also

• Foam::functionObject
• Foam::functionObjects::fvMeshFunctionObject
• Foam::functionObjects::fieldExpression
• ExtendedCodeGuide::functionObjects::field::div

Source files

• div.H
• div.C
• divTemplates.C

Definition at line 148 of file div.H.

Constructor & Destructor Documentation

div() [1/2]

div	(	const word &	name,
		const Time &	runTime,
		const dictionary &	dict
	)

Definition at line 69 of file div.C.

div() [2/2]

div ( const div &  )

delete

~div()

virtual ~div ( )

virtualdefault

Member Function Documentation

TypeName()

TypeName

(

"div"

)

operator=()

void operator= ( const div &  )

delete

write()

bool write ( )

virtual

Reimplemented from fieldExpression.

Definition at line 51 of file div.C.

---

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

• src/functionObjects/field/div/div.H
• src/functionObjects/field/div/div.C
• src/functionObjects/field/div/divTemplates.C