Function to generate a plot of the distribution of the values in a Lagrangian field. More...

Inheritance diagram for LagrangianDistribution:

Collaboration diagram for LagrangianDistribution:

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

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

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

virtual	~LagrangianDistribution ()
	Destructor. More...

virtual bool	read (const dictionary &)
	Read parameters. More...

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

virtual bool	execute ()
	Execute. Does nothing. More...

virtual bool	write ()
	Write the sum. More...

void	operator= (const LagrangianDistribution &)=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	executeAtStart () const
	Return true if the functionObject should be executed at the start. 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...

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 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 in a Lagrangian field.

Usage

Property	Description	Required?	Default
`Lagrangian`	Name of the Lagrangian mesh	yes
`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	yes
`setFormat`	Format of the plot file	yes

Example specification to generate the diameter distribution:

    LagrangianDistribution1
    {
        type            LagrangianDistribution;
        libs            ("libLagrangianFunctionObjects.so");
        Lagrangian      cloud;
        field           d;
        weightField     number;
        nBins           20;
        setFormat       raw;
    }

Source files

Definition at line 121 of file LagrangianDistribution.H.

Constructor & Destructor Documentation

◆ LagrangianDistribution() [1/2]

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

Construct from Time and dictionary.

Definition at line 267 of file LagrangianDistribution.C.

References dict.

◆ LagrangianDistribution() [2/2]

LagrangianDistribution ( const LagrangianDistribution & )

delete

Disallow default bitwise copy construction.

◆ ~LagrangianDistribution()

~LagrangianDistribution ( )

virtual

Destructor.

Definition at line 286 of file LagrangianDistribution.C.

Member Function Documentation

◆ TypeName()

TypeName ( "LagrangianDistribution" )

Runtime type information.

◆ read()

bool read ( const dictionary & dict )

virtual

Read parameters.

Reimplemented from objectRegistryFunctionObject.

Definition at line 292 of file LagrangianDistribution.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 306 of file LagrangianDistribution.C.

References List< T >::append().

Here is the call graph for this function:

◆ execute()

bool execute ( )

virtual

Execute. Does nothing.

Implements functionObject.

Definition at line 314 of file LagrangianDistribution.C.

◆ write()

bool write ( )

virtual

Write the sum.

Implements functionObject.

Definition at line 320 of file LagrangianDistribution.C.

References Foam::exit(), Foam::FatalError, FatalErrorInFunction, Foam::FOR_ALL_FIELD_TYPES(), forAll, mesh, Foam::returnReduce(), and WRITE_FIELD_VALUE.

Here is the call graph for this function:

◆ operator=()

void operator= ( const LagrangianDistribution & )

delete

Disallow default bitwise assignment.

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

src/Lagrangian/LagrangianFunctionObjects/LagrangianDistribution/LagrangianDistribution.H
src/Lagrangian/LagrangianFunctionObjects/LagrangianDistribution/LagrangianDistribution.C

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ LagrangianDistribution() [1/2]

◆ LagrangianDistribution() [2/2]

◆ ~LagrangianDistribution()

Member Function Documentation

◆ TypeName()

◆ read()

◆ fields()

◆ execute()

◆ write()

◆ operator=()