Base class for Lagrangian source conditions. More...

Inheritance diagram for LagrangianFieldSource< Type >:

[legend]

Collaboration diagram for LagrangianFieldSource< Type >:

Public Member Functions
	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 autoPtr< LagrangianFieldSource< Type > >	clone (const regIOobject &) const =0
	Construct and return a clone 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...

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

Static Public Member Functions
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
static int	disallowGenericLagrangianFieldSource
	Debug switch to disallow the use of genericLagrangianFieldSource. More...

Friends
Ostream &	operator (Ostream &, const LagrangianFieldSource< Type > &)
	Ostream operator. More...

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

Detailed Description

template<class Type>
class Foam::LagrangianFieldSource< Type >

Base class for Lagrangian source conditions.

Source files

Definition at line 57 of file LagrangianFieldSource.H.

Constructor & Destructor Documentation

◆ LagrangianFieldSource() [1/4]

LagrangianFieldSource ( const regIOobject & iIo )

Construct from internal field.

Definition at line 38 of file LagrangianFieldSource.C.

◆ LagrangianFieldSource() [2/4]

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

Construct from internal field and dictionary.

Definition at line 57 of file LagrangianFieldSource.C.

◆ LagrangianFieldSource() [3/4]

LagrangianFieldSource ( const LagrangianFieldSource< Type > & )

delete

Disallow copy without setting the internal field reference.

◆ LagrangianFieldSource() [4/4]

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

Construct as copy setting the internal field reference.

Definition at line 77 of file LagrangianFieldSource.C.

◆ ~LagrangianFieldSource()

~LagrangianFieldSource

virtual

Destructor.

Definition at line 162 of file LagrangianFieldSource.C.

Member Function Documentation

◆ TypeName()

TypeName ( "LagrangianFieldSource< Type >" )

Runtime type information.

◆ declareRunTimeSelectionTable() [1/2]

declareRunTimeSelectionTable	(	autoPtr	,
		LagrangianFieldSource< Type >	,
		null	,
		(const regIOobject &iIo)	,
		(iIo)
	)

Select given internal field.

◆ declareRunTimeSelectionTable() [2/2]

declareRunTimeSelectionTable	(	autoPtr	,
		LagrangianFieldSource< Type >	,
		dictionary	,
		(const regIOobject &iIo, const dictionary &dict)	,
		(iIo, dict)
	)

Select given internal field and dictionary.

◆ clone() [1/2]

autoPtr<LagrangianFieldSource<Type> > clone ( ) const

inline

Disallow clone without setting the internal field reference.

Definition at line 123 of file LagrangianFieldSource.H.

References NotImplemented.

◆ clone() [2/2]

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

pure virtual

Construct and return a clone setting the internal field reference.

Implemented in zeroLagrangianFieldSource< Type >, uniformFixedValueLagrangianFieldSource< Type >, NaNLagrangianFieldSource< Type >, maxLagrangianFieldSource< Type >, internalLagrangianFieldSource< Type >, carrierLagrangianFieldSource< Type >, and genericLagrangianFieldSource< Type >.

◆ New() [1/2]

Foam::autoPtr< Foam::LagrangianFieldSource< Type > > New	(	const word &	fieldSourceType,
		const regIOobject &	iIo
	)

static

Return a pointer to a new field source.

Definition at line 100 of file LagrangianFieldSource.C.

References Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, and Foam::nl.

Here is the call graph for this function:

◆ New() [2/2]

Foam::autoPtr< Foam::LagrangianFieldSource< Type > > New	(	const regIOobject &	iIo,
		const dictionary &	dict
	)

static

Return a pointer to a new field source created from a dictionary.

Definition at line 124 of file LagrangianFieldSource.C.

References dict, dictionaryName::dictName(), Foam::endl(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, Foam::libs, dictionary::lookup(), Foam::nl, and dlLibraryTable::open().

Here is the call graph for this function:

◆ internalDimensions()

const Foam::dimensionSet & internalDimensions

virtual

Return internal dimensions reference.

Implements LagrangianFieldSourceBase.

Definition at line 170 of file LagrangianFieldSource.C.

References Foam::exit(), Foam::FatalError, FatalErrorInFunction, and Foam::notNull().

Here is the call graph for this function:

◆ internalField()

const Foam::LagrangianInternalDynamicField< Type > & internalField

Return internal field reference.

Definition at line 193 of file LagrangianFieldSource.C.

References Foam::exit(), Foam::FatalError, FatalErrorInFunction, and Foam::notNull().

Here is the call graph for this function:

◆ sourceValue()

Foam::tmp< Foam::LagrangianSubField< Type > > sourceValue	(	const LagrangianSource &	source,
		const LagrangianSubMesh &	subMesh
	)		const

virtual

Return the source value.

Reimplemented in zeroLagrangianFieldSource< Type >, uniformFixedValueLagrangianFieldSource< Type >, NaNLagrangianFieldSource< Type >, maxLagrangianFieldSource< Type >, and internalLagrangianFieldSource< Type >.

Definition at line 211 of file LagrangianFieldSource.C.

References Foam::exit(), Foam::FatalError, FatalErrorInFunction, LagrangianModel::name(), and Foam::type().

Here is the call graph for this function:

◆ internalCoeff()

Foam::tmp< Foam::LagrangianSubScalarField > internalCoeff	(	const LagrangianSource &	source,
		const LagrangianSubMesh &	subMesh
	)		const

virtual

Return the internal coefficient.

Reimplemented in zeroLagrangianFieldSource< Type >, uniformFixedValueLagrangianFieldSource< Type >, NaNLagrangianFieldSource< Type >, maxLagrangianFieldSource< Type >, and internalLagrangianFieldSource< Type >.

Definition at line 229 of file LagrangianFieldSource.C.

References Foam::exit(), Foam::FatalError, FatalErrorInFunction, LagrangianModel::name(), and Foam::type().

Here is the call graph for this function:

◆ sourceCoeff()

Foam::tmp< Foam::LagrangianSubField< Type > > sourceCoeff	(	const LagrangianSource &	source,
		const LagrangianSubMesh &	subMesh
	)		const

Return the source coefficient.

Definition at line 247 of file LagrangianFieldSource.C.

◆ value() [1/3]

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

Return the value for a continuous source.

Definition at line 259 of file LagrangianFieldSource.C.

References LagrangianSubMesh::sub().

Here is the call graph for this function:

◆ value() [2/3]

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

virtual

Return the value for an instantaneous injection.

Reimplemented in zeroLagrangianFieldSource< Type >, uniformFixedValueLagrangianFieldSource< Type >, NaNLagrangianFieldSource< Type >, maxLagrangianFieldSource< Type >, and carrierLagrangianFieldSource< Type >.

Definition at line 273 of file LagrangianFieldSource.C.

References Foam::exit(), Foam::FatalError, FatalErrorInFunction, LagrangianModel::name(), and Foam::type().

Here is the call graph for this function:

◆ value() [3/3]

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

virtual

Return the value without a model.

Reimplemented in uniformFixedValueLagrangianFieldSource< Type >, and carrierLagrangianFieldSource< Type >.

Definition at line 291 of file LagrangianFieldSource.C.

References Foam::exit(), Foam::FatalError, FatalErrorInFunction, and Foam::type().

Here is the call graph for this function:

◆ write()

void write ( Ostream & os ) const

virtual

Write.

Reimplemented in uniformFixedValueLagrangianFieldSource< Type >, carrierLagrangianFieldSource< Type >, and genericLagrangianFieldSource< Type >.

Definition at line 306 of file LagrangianFieldSource.C.

References Foam::type(), and Foam::writeEntry().

Referenced by carrierLagrangianFieldSource< Type >::write(), and uniformFixedValueLagrangianFieldSource< Type >::write().

Here is the call graph for this function:

Here is the caller graph for this function:

Friends And Related Function Documentation

◆ operator

Ostream& operator	(	Ostream &	,
		const LagrangianFieldSource< Type > &
	)

friend

Ostream operator.

Member Data Documentation

◆ disallowGenericLagrangianFieldSource

int disallowGenericLagrangianFieldSource

static

Debug switch to disallow the use of genericLagrangianFieldSource.

Definition at line 80 of file LagrangianFieldSource.H.

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

src/Lagrangian/Lagrangian/fields/LagrangianFields/LagrangianFieldsFwd.H
src/Lagrangian/Lagrangian/fields/LagrangianFieldSources/LagrangianFieldSource/LagrangianFieldSource.H
src/Lagrangian/Lagrangian/fields/LagrangianFieldSources/LagrangianFieldSource/LagrangianFieldSource.C

Public Member Functions

Static Public Member Functions

Static Public Attributes

Friends

Additional Inherited Members

Detailed Description

template<class Type> class Foam::LagrangianFieldSource< Type >

Constructor & Destructor Documentation

◆ LagrangianFieldSource() [1/4]

◆ LagrangianFieldSource() [2/4]

◆ LagrangianFieldSource() [3/4]

◆ LagrangianFieldSource() [4/4]

◆ ~LagrangianFieldSource()

Member Function Documentation

◆ TypeName()

◆ declareRunTimeSelectionTable() [1/2]

◆ declareRunTimeSelectionTable() [2/2]

◆ clone() [1/2]

◆ clone() [2/2]

◆ New() [1/2]

◆ New() [2/2]

◆ internalDimensions()

◆ internalField()

◆ sourceValue()

◆ internalCoeff()

◆ sourceCoeff()

◆ value() [1/3]

◆ value() [2/3]

◆ value() [3/3]

◆ write()

Friends And Related Function Documentation

◆ operator

Member Data Documentation

◆ disallowGenericLagrangianFieldSource

template<class Type>
class Foam::LagrangianFieldSource< Type >