This source condition creates a Lagrangian value interpolated from a given carrier field. By default the field chosen is that with the same name as the Lagrangian field, but this can be overridden with the fieldc control. More...

Inheritance diagram for carrierLagrangianFieldSource< Type >:

[legend]

Collaboration diagram for carrierLagrangianFieldSource< Type >:

[legend]

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

	carrierLagrangianFieldSource (const regIOobject &)
	Construct from internal field. More...

	carrierLagrangianFieldSource (const regIOobject &, const dictionary &dict)
	Construct from internal field and dictionary. More...

	carrierLagrangianFieldSource (const carrierLagrangianFieldSource &, const regIOobject &)
	Copy constructor setting the internal field reference. More...

virtual autoPtr< LagrangianFieldSource< Type > >	clone (const regIOobject &iIo) const
	Construct and return a clone setting the internal field reference. More...

virtual	~carrierLagrangianFieldSource ()
	Destructor. More...

virtual tmp< LagrangianSubField< Type > >	value (const LagrangianInjection &, const LagrangianSubMesh &) const
	Return the value for an instantaneous injection. More...

virtual tmp< LagrangianSubField< Type > >	value (const LagrangianSubMesh &) const
	Return the value without a model. More...

virtual void	write (Ostream &) const
	Write. More...

Public Member Functions inherited from LagrangianFieldSource< Type >
	TypeName ("LagrangianFieldSource")
	Runtime type information. More...

	declareRunTimeSelectionTable (autoPtr, LagrangianFieldSource, null,(const regIOobject &iIo),(iIo))
	Select given internal field. More...

	declareRunTimeSelectionTable (autoPtr, LagrangianFieldSource, dictionary,(const regIOobject &iIo, const dictionary &dict),(iIo, dict))
	Select given internal field and dictionary. More...

	LagrangianFieldSource (const regIOobject &)
	Construct from internal field. More...

	LagrangianFieldSource (const regIOobject &, const dictionary &)
	Construct from internal field and dictionary. More...

	LagrangianFieldSource (const LagrangianFieldSource< Type > &)=delete
	Disallow copy without setting the internal field reference. More...

autoPtr< LagrangianFieldSource< Type > >	clone () const
	Disallow clone without setting the internal field reference. More...

	LagrangianFieldSource (const LagrangianFieldSource< Type > &, const regIOobject &)
	Construct as copy setting the internal field reference. More...

virtual	~LagrangianFieldSource ()
	Destructor. More...

virtual const dimensionSet &	internalDimensions () const
	Return internal dimensions reference. More...

const LagrangianInternalDynamicField< Type > &	internalField () const
	Return internal field reference. More...

virtual tmp< LagrangianSubField< Type > >	sourceValue (const LagrangianSource &, const LagrangianSubMesh &) const
	Return the source value. More...

virtual tmp< LagrangianSubScalarField >	internalCoeff (const LagrangianSource &, const LagrangianSubMesh &) const
	Return the internal coefficient. More...

tmp< LagrangianSubField< Type > >	sourceCoeff (const LagrangianSource &, const LagrangianSubMesh &) const
	Return the source coefficient. More...

tmp< LagrangianSubField< Type > >	value (const LagrangianSource &, const LagrangianSubMesh &) const
	Return the value for a continuous source. More...

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

	LagrangianFieldSourceBase (const regIOobject &)
	Construct from internal field. More...

virtual	~LagrangianFieldSourceBase ()
	Destructor. More...

const objectRegistry &	db () const
	Return local objectRegistry. More...

const Time &	time () const
	Return time. More...

const word &	internalName () const
	Return internal field name. More...

word	internalGroup () const
	Return internal field group. More...

template<class OtherFieldSourceType >
const OtherFieldSourceType &	fieldSourceCast (const LagrangianModel &) const
	Cast a to the specified type. Handle errors. More...

template<class OtherType >
const LagrangianFieldSource< OtherType > &	fieldSource (const word &name, const LagrangianModel &) const
	Lookup and return another field source. More...

template<class OtherType , class OtherFieldSourceType >
const OtherFieldSourceType &	fieldSourceCast (const word &name, const LagrangianModel &) const
	Lookup and return another field source and then cast to a. More...

template<class OtherModelType >
const OtherModelType &	modelCast (const LagrangianModel &) const
	Cast a model to the specified type. Handle errors. More...

template<class OtherType >
tmp< LagrangianSubField< OtherType > >	value (const word &name, const LagrangianSource &, const LagrangianSubMesh &) const
	Lookup and return the value of another field source. More...

template<class OtherType >
tmp< LagrangianSubField< OtherType > >	value (const word &name, const LagrangianInjection &, const LagrangianSubMesh &) const
	Lookup and return the value of another field source. More...

template<class OtherType >
const Foam::LagrangianFieldSource< OtherType > &	fieldSource (const word &name, const LagrangianModel &model) const

template<class OtherType >
Foam::tmp< Foam::LagrangianSubField< OtherType > >	value (const word &name, const LagrangianSource &source, const LagrangianSubMesh &subMesh) const

template<class OtherType >
Foam::tmp< Foam::LagrangianSubField< OtherType > >	value (const word &name, const LagrangianInjection &injection, const LagrangianSubMesh &subMesh) const

Additional Inherited Members
Static Public Member Functions inherited from LagrangianFieldSource< Type >
static autoPtr< LagrangianFieldSource< Type > >	New (const word &fieldSourceType, const regIOobject &)
	Return a pointer to a new field source. More...

static autoPtr< LagrangianFieldSource< Type > >	New (const regIOobject &, const dictionary &)
	Return a pointer to a new field source created from a dictionary. More...

Static Public Attributes inherited from LagrangianFieldSource< Type >
static int	disallowGenericLagrangianFieldSource
	Debug switch to disallow the use of genericLagrangianFieldSource. More...

Protected Attributes inherited from LagrangianFieldSourceBase
const regIOobject &	internalIo_
	Reference to the internal IO object. More...

Detailed Description

template<class Type>
class Foam::carrierLagrangianFieldSource< Type >

This source condition creates a Lagrangian value interpolated from a given carrier field. By default the field chosen is that with the same name as the Lagrangian field, but this can be overridden with the fieldc control.

Usage

Property	Description	Required?	Default
`fieldc`	The carrier field name	no	The Lagrangian field name

Example specification:

    <LagrangianModelName>
    {
        type            carrier;
        fieldc          U.air;
    }

Source files

Definition at line 78 of file carrierLagrangianFieldSource.H.

Constructor & Destructor Documentation

◆ carrierLagrangianFieldSource() [1/3]

carrierLagrangianFieldSource ( const regIOobject & iIo )

Construct from internal field.

Definition at line 34 of file carrierLagrangianFieldSource.C.

Referenced by carrierLagrangianFieldSource< Type >::clone().

Here is the caller graph for this function:

◆ carrierLagrangianFieldSource() [2/3]

carrierLagrangianFieldSource	(	const regIOobject &	iIo,
		const dictionary &	dict
	)

Construct from internal field and dictionary.

Definition at line 46 of file carrierLagrangianFieldSource.C.

◆ carrierLagrangianFieldSource() [3/3]

carrierLagrangianFieldSource	(	const carrierLagrangianFieldSource< Type > &	field,
		const regIOobject &	iIo
	)

Copy constructor setting the internal field reference.

Definition at line 59 of file carrierLagrangianFieldSource.C.

◆ ~carrierLagrangianFieldSource()

~carrierLagrangianFieldSource

virtual

Destructor.

Definition at line 74 of file carrierLagrangianFieldSource.C.

Member Function Documentation

◆ TypeName()

TypeName ( "carrier" )

Runtime type information.

◆ clone()

virtual autoPtr<LagrangianFieldSource<Type> > clone ( const regIOobject & iIo ) const

inlinevirtual

Construct and return a clone setting the internal field reference.

Implements LagrangianFieldSource< Type >.

Definition at line 117 of file carrierLagrangianFieldSource.H.

References carrierLagrangianFieldSource< Type >::carrierLagrangianFieldSource().

Here is the call graph for this function:

◆ value() [1/2]

Foam::tmp< Foam::LagrangianSubField< Type > > value	(	const LagrangianInjection &	injection,
		const LagrangianSubMesh &	subMesh
	)		const

virtual

Return the value for an instantaneous injection.

Reimplemented from LagrangianFieldSource< Type >.

Definition at line 82 of file carrierLagrangianFieldSource.C.

◆ value() [2/2]

Foam::tmp< Foam::LagrangianSubField< Type > > value ( const LagrangianSubMesh & subMesh ) const

virtual

Return the value without a model.

Reimplemented from LagrangianFieldSource< Type >.

Definition at line 94 of file carrierLagrangianFieldSource.C.

References objectRegistry::lookupObject(), LagrangianSubMesh::mesh(), and LagrangianMesh::poly().

Here is the call graph for this function:

◆ write()

void write ( Ostream & os ) const

virtual

Write.

Reimplemented from LagrangianFieldSource< Type >.

Definition at line 108 of file carrierLagrangianFieldSource.C.

References LagrangianFieldSource< Type >::write().

Here is the call graph for this function:

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

src/Lagrangian/cloud/fields/derivedLagrangianFieldSources/carrier/carrierLagrangianFieldSource.H
src/Lagrangian/cloud/fields/derivedLagrangianFieldSources/carrier/carrierLagrangianFieldSource.C

Public Member Functions

Additional Inherited Members

Detailed Description

template<class Type> class Foam::carrierLagrangianFieldSource< Type >

Constructor & Destructor Documentation

◆ carrierLagrangianFieldSource() [1/3]

◆ carrierLagrangianFieldSource() [2/3]

◆ carrierLagrangianFieldSource() [3/3]

◆ ~carrierLagrangianFieldSource()

Member Function Documentation

◆ TypeName()

◆ clone()

◆ value() [1/2]

◆ value() [2/2]

◆ write()

template<class Type>
class Foam::carrierLagrangianFieldSource< Type >