Function to generate a plot of the distribution of the values of particles that pass through a face-zone, face-set or patch. More...

Inheritance diagram for cloudSurfaceDistribution:

[legend]

Collaboration diagram for cloudSurfaceDistribution:

[legend]

Public Types
enum class	selectionType { faceZone , faceSet , patch }
	Selection type enumeration. More...

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

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

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

virtual	~cloudSurfaceDistribution ()
	Destructor. More...

virtual bool	read (const dictionary &)
	Read parameters. 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	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 bool	write ()
	Write the number flux. More...

virtual bool	clear ()
	Clear the number flux. 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 cloudSurfaceDistribution &)=delete
	Disallow default bitwise assignment. More...

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

	LagrangianMeshFunctionObject (const word &name, const Time &runTime, const dictionary &dict, const word &LagrangianKeyword="Lagrangian")
	Construct from Time and dictionary. More...

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

virtual	~LagrangianMeshFunctionObject ()
	Destructor. More...

const LagrangianMesh &	mesh () const
	Access the mesh. More...

void	operator= (const LagrangianMeshFunctionObject &)=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...

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

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	preSolve ()
	Hook before solution steps. 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...

Static Public Attributes
static const NamedEnum< selectionType, 3 >	selectionTypeNames {"faceZone", "faceSet", "patch"}
	Selection type names. More...

Static Public Attributes inherited from functionObject
static bool	postProcess
	Global post-processing mode switch. 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...

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 objectRegistryFunctionObject
const objectRegistry &	obr_
	Reference to the objectRegistry. More...

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

Detailed Description

Function to generate a plot of the distribution of the values of particles that pass through a face-zone, face-set or patch.

Usage

Property	Description	Required?	Default
`cloud`	Name of the cloud	yes
`select`	The type of face selection; </td>
`faceZone`, faceSet or patch	if none or multiple </td>
`selections` specified
`faceZone`	The face zone for which the </td>
`PDF` is calculated	if select is faceZone
`faceSet`	The face set for which the </td>
`PDF` is calculated	if select is faceSet
`patch`	The patch for which the </td>
`PDF` is calculated	is select is patch
`field`	Field to operate on	if fields not specified
`fields`	List of fields to operate on	if field not specified
`weightField`	Field with which to weight the distribution	no	none
`weightFields`	List of fields with which to </td>
`weight` the distribution	no	none
`nBins`	The number of bins used in the plot(s)	yes
`setFormat`	Format of the plot file	yes

Example specification to generate the diameter distribution:

    cloudSurfaceDistribution1
    {
        type            cloudSurfaceDistribution;
        libs            ("libLagrangianCloudFunctionObjects.so");
        cloud           cloud;
        patch           outlet;
        field           d;
        weightField     number;
        nBins           20;
        setFormat       raw;
    }

Source files

Definition at line 161 of file cloudSurfaceDistribution.H.

Member Enumeration Documentation

◆ selectionType

enum selectionType

strong

Selection type enumeration.

Enumerator
faceZone
faceSet
patch

Definition at line 171 of file cloudSurfaceDistribution.H.

Constructor & Destructor Documentation

◆ cloudSurfaceDistribution() [1/2]

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

Construct from Time and dictionary.

Definition at line 500 of file cloudSurfaceDistribution.C.

References dict, typeIOobject< Type >::headerOk(), IOobject::MUST_READ, and propsDict().

Here is the call graph for this function:

◆ cloudSurfaceDistribution() [2/2]

cloudSurfaceDistribution ( const cloudSurfaceDistribution & )

delete

Disallow default bitwise copy construction.

◆ ~cloudSurfaceDistribution()

~cloudSurfaceDistribution ( )

virtual

Destructor.

Definition at line 549 of file cloudSurfaceDistribution.C.

Member Function Documentation

◆ TypeName()

TypeName ( "cloudSurfaceDistribution" )

Runtime type information.

◆ read()

bool read ( const dictionary & dict )

virtual

Read parameters.

Reimplemented from objectRegistryFunctionObject.

Definition at line 555 of file cloudSurfaceDistribution.C.

References dict, and objectRegistryFunctionObject::read().

Here is the call graph for this function:

◆ fields()

Foam::wordList fields ( ) const

virtual

Return the list of fields required.

Implements functionObject.

Definition at line 572 of file cloudSurfaceDistribution.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 578 of file cloudSurfaceDistribution.C.

◆ execute()

bool execute ( )

virtual

Do nothing. Everything happens in faces crossing hooks.

Implements functionObject.

Definition at line 584 of file cloudSurfaceDistribution.C.

◆ preCrossFaces()

void preCrossFaces ( const LagrangianSubScalarSubField & fraction )

virtual

Hook before face crossings of a specific sub-mesh.

Reimplemented from cloudFunctionObject.

Definition at line 590 of file cloudSurfaceDistribution.C.

◆ postCrossFaces()

void postCrossFaces ( const LagrangianSubScalarSubField & fraction )

virtual

Hook following face crossings of a specific sub-mesh.

Reimplemented from cloudFunctionObject.

Definition at line 597 of file cloudSurfaceDistribution.C.

References ADD_FIELD, Foam::exit(), Foam::FatalError, FatalErrorInFunction, Foam::FOR_ALL_FIELD_TYPES(), forAll, LagrangianSubMesh::group(), DimensionedField< Type, GeoMesh, PrimitiveField >::mesh(), MULTIPLY_WEIGHT, Foam::onPatchZero, and LagrangianSubMesh::size().

Here is the call graph for this function:

◆ write()

bool write ( )

virtual

Write the number flux.

Implements functionObject.

Definition at line 654 of file cloudSurfaceDistribution.C.

References f(), UList< T >::first(), forAll, unintegrable::integrate(), UList< T >::last(), Pstream::listCombineGather(), Pstream::listCombineScatter(), mesh, IOobject::NO_READ, propsDict(), range, Foam::returnReduce(), Foam::sum(), and x.

Here is the call graph for this function:

◆ clear()

bool clear ( )

virtual

Clear the number flux.

Definition at line 730 of file cloudSurfaceDistribution.C.

◆ topoChange()

void topoChange ( const polyTopoChangeMap & map )

virtual

Update topology using the given map.

Reimplemented from functionObject.

Definition at line 736 of file cloudSurfaceDistribution.C.

References mesh.

◆ mapMesh()

void mapMesh ( const polyMeshMap & )

virtual

Update from another mesh using the given map.

Reimplemented from functionObject.

Definition at line 748 of file cloudSurfaceDistribution.C.

References mesh.

◆ distribute()

void distribute ( const polyDistributionMap & )

virtual

Redistribute or update using the given distribution map.

Reimplemented from functionObject.

Definition at line 760 of file cloudSurfaceDistribution.C.

References mesh.

◆ operator=()

void operator= ( const cloudSurfaceDistribution & )

delete

Disallow default bitwise assignment.

Member Data Documentation

◆ selectionTypeNames

const Foam::NamedEnum< Foam::functionObjects::cloudSurfaceDistribution::selectionType, 3 > selectionTypeNames {"faceZone", "faceSet", "patch"}

static

Selection type names.

Definition at line 179 of file cloudSurfaceDistribution.H.

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

src/Lagrangian/cloudFunctionObjects/cloudSurfaceDistribution/cloudSurfaceDistribution.H
src/Lagrangian/cloudFunctionObjects/cloudSurfaceDistribution/cloudSurfaceDistribution.C

Public Types

Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ selectionType

Constructor & Destructor Documentation

◆ cloudSurfaceDistribution() [1/2]

◆ cloudSurfaceDistribution() [2/2]

◆ ~cloudSurfaceDistribution()

Member Function Documentation

◆ TypeName()

◆ read()

◆ fields()

◆ executeAtStart()

◆ execute()

◆ preCrossFaces()

◆ postCrossFaces()

◆ write()

◆ clear()

◆ topoChange()

◆ mapMesh()

◆ distribute()

◆ operator=()

Member Data Documentation

◆ selectionTypeNames