Base class for functions which generate a boundary collision flux for a cloud. More...

Inheritance diagram for cloudBoundaryCollisionFlux:

[legend]

Collaboration diagram for cloudBoundaryCollisionFlux:

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

	cloudBoundaryCollisionFlux (const word &name, const Time &runTime, const dictionary &dict, const word &phiName, const dimensionSet &phiDims)
	Construct from Time and dictionary. More...

	cloudBoundaryCollisionFlux (const cloudBoundaryCollisionFlux &)=delete
	Disallow default bitwise copy construction. More...

virtual	~cloudBoundaryCollisionFlux ()
	Destructor. More...

virtual wordList	fields () const
	Return the list of fields required. More...

virtual bool	executeAtStart () const
	Return false so this function does not execute at the start. More...

virtual bool	execute ()
	Do nothing. Everything happens in faces crossing hooks. More...

virtual void	preSolve ()
	Hook before solution steps. More...

virtual void	preCrossFaces (const LagrangianScalarInternalDynamicField &fraction)
	Hook before all face crossings. More...

virtual void	preCrossFaces (const LagrangianSubScalarSubField &fraction)
	Hook before face crossings of a specific sub-mesh. More...

virtual void	postCrossFaces (const LagrangianSubScalarSubField &fraction)
	Hook following face crossings of a specific sub-mesh. More...

virtual void	postCrossFaces (const LagrangianScalarInternalDynamicField &fraction)
	Hook after all face crossings. More...

virtual bool	write ()
	Write the number flux. More...

virtual bool	clear ()
	Clear the number flux. More...

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

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

	cloudFvMeshFunctionObject (const word &name, const Time &runTime, const dictionary &dict)
	Construct from Time and dictionary. More...

	cloudFvMeshFunctionObject (const cloudFvMeshFunctionObject &)=delete
	Disallow default bitwise copy construction. More...

virtual	~cloudFvMeshFunctionObject ()
	Destructor. More...

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

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

	fvMeshFunctionObject (const word &name, const Time &runTime, const dictionary &dict)
	Construct from Time and dictionary. More...

	fvMeshFunctionObject (const word &name, const objectRegistry &obr)
	Construct from the region objectRegistry. More...

	fvMeshFunctionObject (const fvMeshFunctionObject &)=delete
	Disallow default bitwise copy construction. More...

virtual	~fvMeshFunctionObject ()
	Destructor. More...

const fvMesh &	mesh () const
	Return a reference to the mesh. More...

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

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

	regionFunctionObject (const word &name, const Time &runTime, const dictionary &dict)
	Construct from Time and dictionary. More...

	regionFunctionObject (const word &name, const objectRegistry &obr)
	Construct from the region objectRegistry. More...

	regionFunctionObject (const regionFunctionObject &)=delete
	Disallow default bitwise copy construction. More...

virtual	~regionFunctionObject ()
	Destructor. More...

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

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

	objectRegistryFunctionObject (const word &name, const objectRegistry &obr, const dictionary &dict)
	Construct from an objectRegistry and dictionary. More...

	objectRegistryFunctionObject (const word &name, const objectRegistry &obr)
	Construct from an objectRegistry. More...

	objectRegistryFunctionObject (const objectRegistryFunctionObject &)=delete
	Disallow default bitwise copy construction. More...

virtual	~objectRegistryFunctionObject ()
	Destructor. More...

virtual bool	read (const dictionary &)
	Read optional controls. More...

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

Public Member Functions inherited from functionObject
	ClassName ("functionObject")

virtual const word &	type () const =0
	Runtime type information. More...

	declareRunTimeSelectionTable (autoPtr, functionObject, dictionary,(const word &name, const Time &runTime, const dictionary &dict),(name, runTime, dict))

	functionObject (const word &name, const Time &runTime)
	Construct from components. More...

	functionObject (const word &name, const Time &runTime, const dictionary &dict)
	Construct from dictionary. More...

autoPtr< functionObject >	clone () const
	Return clone. More...

	functionObject (const functionObject &)=delete
	Disallow default bitwise copy construction. More...

virtual	~functionObject ()
	Destructor. More...

const word &	name () const
	Return the name of this functionObject. More...

virtual bool	end ()
	Called when Time::run() determines that the time-loop exits. More...

virtual scalar	timeToNextAction ()
	Called by Time::adjustTimeStep(). Allows the functionObject to. More...

virtual scalar	maxDeltaT () const
	Return the maximum time-step for stable operation. More...

virtual void	movePoints (const polyMesh &mesh)
	Update topology using the given map. More...

virtual void	topoChange (const polyTopoChangeMap &map)
	Update topology using the given map. More...

virtual void	mapMesh (const polyMeshMap &)
	Update from another mesh using the given map. More...

virtual void	distribute (const polyDistributionMap &)
	Redistribute or update using the given distribution map. More...

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

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

	cloudFunctionObject (const LagrangianMeshFunctionObject &)
	Construct from a Lagrangian mesh function object. More...

	cloudFunctionObject (const fvMeshFunctionObject &, const dictionary &dict)
	Construct from an fvMesh function object and a dictionary. More...

	cloudFunctionObject (const cloudFunctionObject &)=delete
	Disallow default bitwise copy construction. More...

virtual	~cloudFunctionObject ()
	Destructor. More...

const Foam::cloud &	cloud () const
	Return the cloud. More...

virtual void	calculate (const LagrangianSubScalarField &deltaT, const bool final)
	Solve equations and/or update continually changing properties. More...

virtual void	postSolve ()
	Hook following solution steps. More...

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

Additional Inherited Members
Static Public Member Functions inherited from functionObject
static autoPtr< functionObject >	New (const word &name, const Time &, const dictionary &)
	Select from dictionary, based on its "type" entry. More...

Public Attributes inherited from functionObject
Switch	log
	Switch write log to Info. More...

Switch	executeAtStart_
	Switch execute at start time. More...

Static Public Attributes inherited from functionObject
static bool	postProcess
	Global post-processing mode switch. More...

Protected Member Functions inherited from objectRegistryFunctionObject
template<class ObjectType >
bool	foundObject (const word &fieldName) const
	Find field in the objectRegistry. More...

template<class ObjectType >
void	cannotFindObject (const word &fieldName)
	Prints a warning message that fieldName cannot be found. More...

void	cannotFindObject (const word &fieldName)
	Prints a warning message that fieldName cannot be found. More...

void	cannotFindObjects (const wordList &fieldNames)
	Prints a warning message that fieldNames cannot be found. More...

template<class ObjectType >
const ObjectType &	lookupObject (const word &fieldName) const
	Lookup object from the objectRegistry. More...

template<class ObjectType >
ObjectType &	lookupObjectRef (const word &fieldName)
	Lookup non-const object reference from the objectRegistry. More...

template<class ObjectType >
ObjectType &	store (const tmp< ObjectType > &tfield)
	Store the given field in the objectRegistry. More...

template<class ObjectType >
ObjectType &	store (const word &fieldName, const tmp< ObjectType > &tfield, bool cacheable=false)
	Store the given field in the objectRegistry under the given name. More...

bool	writeObject (const word &fieldName)
	Write field if present in objectRegistry. More...

bool	clearObject (const word &fieldName)
	Clear field from the objectRegistry if present. More...

Protected Member Functions inherited from cloudFunctionObject
template<class Cloud >
bool	isCloud () const
	Determine whether the cloud is of the given type. More...

template<class Cloud = Foam::cloud>
const Cloud &	cloud () const
	Get a reference to the cloud. More...

Protected Attributes inherited from fvMeshFunctionObject
const fvMesh &	mesh_
	Reference to the fvMesh. More...

Protected Attributes inherited from objectRegistryFunctionObject
const objectRegistry &	obr_
	Reference to the objectRegistry. More...

Protected Attributes inherited from functionObject
const Time &	time_
	Reference to time. More...

Detailed Description

Base class for functions which generate a boundary collision flux for a cloud.

Source files

Definition at line 54 of file cloudBoundaryCollisionFlux.H.

Constructor & Destructor Documentation

◆ cloudBoundaryCollisionFlux() [1/2]

cloudBoundaryCollisionFlux	(	const word &	name,
		const Time &	runTime,
		const dictionary &	dict,
		const word &	phiName,
		const dimensionSet &	phiDims
	)

Construct from Time and dictionary.

Definition at line 46 of file cloudBoundaryCollisionFlux.C.

◆ cloudBoundaryCollisionFlux() [2/2]

cloudBoundaryCollisionFlux ( const cloudBoundaryCollisionFlux & )

delete

Disallow default bitwise copy construction.

◆ ~cloudBoundaryCollisionFlux()

~cloudBoundaryCollisionFlux ( )

virtual

Destructor.

Definition at line 71 of file cloudBoundaryCollisionFlux.C.

Member Function Documentation

◆ TypeName()

TypeName ( "cloudBoundaryCollisionFlux" )

Runtime type information.

◆ fields()

Foam::wordList fields ( ) const

virtual

Return the list of fields required.

Implements functionObject.

Definition at line 77 of file cloudBoundaryCollisionFlux.C.

References List< word >::null().

Here is the call graph for this function:

◆ executeAtStart()

bool executeAtStart ( ) const

virtual

Return false so this function does not execute at the start.

Reimplemented from functionObject.

Definition at line 83 of file cloudBoundaryCollisionFlux.C.

◆ execute()

bool execute ( )

virtual

Do nothing. Everything happens in faces crossing hooks.

Implements functionObject.

Definition at line 89 of file cloudBoundaryCollisionFlux.C.

◆ preSolve()

void preSolve ( )

virtual

Hook before solution steps.

Reimplemented from cloudFunctionObject.

Definition at line 95 of file cloudBoundaryCollisionFlux.C.

References Foam::Zero.

◆ preCrossFaces() [1/2]

void preCrossFaces ( const LagrangianScalarInternalDynamicField & fraction )

virtual

Hook before all face crossings.

Reimplemented from cloudFunctionObject.

Definition at line 101 of file cloudBoundaryCollisionFlux.C.

References Foam::dimless, Foam::dimTime, mesh, and Foam::name().

Here is the call graph for this function:

◆ preCrossFaces() [2/2]

virtual void preCrossFaces ( const LagrangianSubScalarSubField & fraction )

virtual

Hook before face crossings of a specific sub-mesh.

Reimplemented from cloudFunctionObject.

◆ postCrossFaces() [1/2]

void postCrossFaces ( const LagrangianSubScalarSubField & fraction )

virtual

Hook following face crossings of a specific sub-mesh.

Reimplemented from cloudFunctionObject.

Definition at line 162 of file cloudBoundaryCollisionFlux.C.

References GeometricField< Type, GeoMesh, PrimitiveField >::boundaryField(), Foam::constant::universal::c, forAll, LagrangianSubMesh::group(), Foam::inCell, Foam::inInternalMesh, primitiveMesh::magFaceAreas(), fvMesh::magSf(), DimensionedField< Type, GeoMesh, PrimitiveField >::mesh(), mesh, primitiveMesh::nInternalFaces(), Foam::none, fvMesh::polyBFacePatches(), fvMesh::polyBFacePatchFaces(), LagrangianSubMesh::start(), and LagrangianSubMesh::sub().

Here is the call graph for this function:

◆ postCrossFaces() [2/2]

virtual void postCrossFaces ( const LagrangianScalarInternalDynamicField & fraction )

virtual

Hook after all face crossings.

Reimplemented from cloudFunctionObject.

◆ write()

bool write ( )

virtual

Write the number flux.

Implements functionObject.

Definition at line 221 of file cloudBoundaryCollisionFlux.C.

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

Here is the call graph for this function:

◆ clear()

bool clear ( )

virtual

Clear the number flux.

Definition at line 242 of file cloudBoundaryCollisionFlux.C.

◆ operator=()

void operator= ( const cloudBoundaryCollisionFlux & )

delete

Disallow default bitwise assignment.

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

src/Lagrangian/cloudFunctionObjects/cloudBoundaryCollisionFlux/cloudBoundaryCollisionFlux.H
src/Lagrangian/cloudFunctionObjects/cloudBoundaryCollisionFlux/cloudBoundaryCollisionFlux.C

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ cloudBoundaryCollisionFlux() [1/2]

◆ cloudBoundaryCollisionFlux() [2/2]

◆ ~cloudBoundaryCollisionFlux()

Member Function Documentation

◆ TypeName()

◆ fields()

◆ executeAtStart()

◆ execute()

◆ preSolve()

◆ preCrossFaces() [1/2]

◆ preCrossFaces() [2/2]

◆ postCrossFaces() [1/2]

◆ postCrossFaces() [2/2]

◆ write()

◆ clear()

◆ operator=()