This provides a generic source condition, useful as a fallback for handling unknown types when post-processing or running mesh manipulation utilities. Not generally applicable as a user-specified condition. More...

Inheritance diagram for genericFvFieldSource< Type >:

[legend]

Collaboration diagram for genericFvFieldSource< Type >:

[legend]

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

	genericFvFieldSource (const DimensionedField< Type, volMesh > &, const dictionary &)
	Construct internal field and dictionary. More...

	genericFvFieldSource (const genericFvFieldSource< Type > &, const DimensionedField< Type, volMesh > &)
	Copy constructor setting internal field reference. More...

virtual autoPtr< fvFieldSource< Type > >	clone (const DimensionedField< Type, volMesh > &iF) const
	Construct and return a clone setting internal field reference. More...

virtual	~genericFvFieldSource ()
	Destructor. More...

virtual tmp< DimensionedField< Type, volMesh > >	sourceValue (const fvSource &model, const DimensionedField< scalar, volMesh > &source) const
	Return the source value. More...

virtual tmp< Field< Type > >	sourceValue (const fvSource &model, const scalarField &source, const labelUList &cells) const
	Return the source energy value. More...

virtual tmp< DimensionedField< scalar, volMesh > >	internalCoeff (const fvSource &model, const DimensionedField< scalar, volMesh > &source) const
	Return the source value. More...

virtual tmp< scalarField >	internalCoeff (const fvSource &model, const scalarField &source, const labelUList &cells) const
	Return the internal coefficient. More...

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

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

	genericFieldBase ()
	Construct null. More...

	genericFieldBase (const word &actualTypeName)
	Construct from actual type name. More...

virtual	~genericFieldBase ()
	Destructor. More...

const word &	actualTypeName () const
	Return the actual type name. More...

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

	declareRunTimeSelectionTable (autoPtr, fvFieldSource, null,(const DimensionedField< Type, volMesh > &iF),(iF))
	Select given internal field. More...

	declareRunTimeSelectionTable (autoPtr, fvFieldSource, dictionary,(const DimensionedField< Type, volMesh > &iF, const dictionary &dict),(iF, dict))
	Select given internal field and dictionary. More...

	fvFieldSource (const DimensionedField< Type, volMesh > &)
	Construct from internal field. More...

	fvFieldSource (const DimensionedField< Type, volMesh > &, const dictionary &)
	Construct from internal field and dictionary. More...

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

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

	fvFieldSource (const fvFieldSource< Type > &, const DimensionedField< Type, volMesh > &)
	Copy constructor setting internal field reference. More...

virtual	~fvFieldSource ()
	Destructor. More...

const objectRegistry &	db () const
	Return the local object registry. More...

const DimensionedField< Type, volMesh > &	internalField () const
	Return the internal field reference. More...

virtual tmp< DimensionedField< Type, volMesh > >	sourceCoeff (const fvSource &model, const DimensionedField< scalar, volMesh > &source) const
	Return the source coefficient. More...

virtual tmp< Field< Type > >	sourceCoeff (const fvSource &model, const scalarField &source, const labelUList &cells) const
	Return the source coefficient. More...

tmp< DimensionedField< Type, volMesh > >	value (const fvSource &model, const DimensionedField< scalar, volMesh > &source) const
	Return the value. More...

tmp< Field< Type > >	value (const fvSource &model, const scalarField &source, const labelUList &cells) const
	Return the value. More...

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

template<class OtherType >
tmp< DimensionedField< OtherType, volMesh > >	value (const word &name, const fvSource &model, const DimensionedField< scalar, volMesh > &source) const
	Lookup and return the value of another field source. More...

template<class OtherType >
tmp< Field< OtherType > >	value (const word &name, const fvSource &model, const scalarField &source, const labelUList &cells) const
	Lookup and return the value of another field source. More...

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

template<class OtherType >
Foam::tmp< Foam::DimensionedField< OtherType, Foam::volMesh > >	value (const word &name, const fvSource &model, const DimensionedField< scalar, volMesh > &source) const

template<class OtherType >
Foam::tmp< Foam::Field< OtherType > >	value (const word &name, const fvSource &model, const scalarField &source, const labelUList &cells) const

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

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

Static Public Attributes inherited from fvFieldSource< Type >
static int	disallowGenericFvFieldSource
	Debug switch to disallow the use of genericFvFieldSource. More...

Detailed Description

template<class Type>
class Foam::genericFvFieldSource< Type >

This provides a generic source condition, useful as a fallback for handling unknown types when post-processing or running mesh manipulation utilities. Not generally applicable as a user-specified condition.

Source files

Definition at line 52 of file genericFvFieldSource.H.

Constructor & Destructor Documentation

◆ genericFvFieldSource() [1/2]

genericFvFieldSource	(	const DimensionedField< Type, volMesh > &	iF,
		const dictionary &	dict
	)

Construct internal field and dictionary.

Definition at line 31 of file genericFvFieldSource.C.

◆ genericFvFieldSource() [2/2]

genericFvFieldSource	(	const genericFvFieldSource< Type > &	stf,
		const DimensionedField< Type, volMesh > &	iF
	)

Copy constructor setting internal field reference.

Definition at line 44 of file genericFvFieldSource.C.

◆ ~genericFvFieldSource()

~genericFvFieldSource

virtual

Destructor.

Definition at line 59 of file genericFvFieldSource.C.

Member Function Documentation

◆ TypeName()

TypeName ( "generic" )

Runtime type information.

◆ clone()

virtual autoPtr<fvFieldSource<Type> > clone ( const DimensionedField< Type, volMesh > & iF ) const

inlinevirtual

Construct and return a clone setting internal field reference.

Implements fvFieldSource< Type >.

Definition at line 86 of file genericFvFieldSource.H.

◆ sourceValue() [1/2]

Foam::tmp< Foam::DimensionedField< Type, Foam::volMesh > > sourceValue	(	const fvSource &	model,
		const DimensionedField< scalar, volMesh > &	source
	)		const

virtual

Return the source value.

Implements fvFieldSource< Type >.

Definition at line 67 of file genericFvFieldSource.C.

References Foam::abort(), Foam::FatalError, FatalErrorInFunction, and fvModel::name().

Here is the call graph for this function:

◆ sourceValue() [2/2]

Foam::tmp< Foam::Field< Type > > sourceValue	(	const fvSource &	model,
		const scalarField &	source,
		const labelUList &	cells
	)		const

virtual

Return the source energy value.

Reimplemented from fvFieldSource< Type >.

Definition at line 89 of file genericFvFieldSource.C.

References Foam::abort(), Foam::FatalError, FatalErrorInFunction, and fvModel::name().

Here is the call graph for this function:

◆ internalCoeff() [1/2]

Foam::tmp< Foam::DimensionedField< Foam::scalar, Foam::volMesh > > internalCoeff	(	const fvSource &	model,
		const DimensionedField< scalar, volMesh > &	source
	)		const