This source condition provides a uniform fixed value. More...

Inheritance diagram for uniformFixedValueFvFieldSource< Type >:

Collaboration diagram for uniformFixedValueFvFieldSource< Type >:

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

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

	uniformFixedValueFvFieldSource (const uniformFixedValueFvFieldSource< 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	~uniformFixedValueFvFieldSource ()
	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 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 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::uniformFixedValueFvFieldSource< Type >

This source condition provides a uniform fixed value.

Usage

Property	Description	Required	Default value
`uniformValue`	uniform value	yes

Example of the source condition specification with a constant value:

    <sourceName>
    {
        type            uniformFixedValue;
        uniformValue    0.1;
    }

Example of the source condition specification with a time-varying value:

    <sourceName>
    {
        type            uniformFixedValue;
        uniformValue
        {
            type            table;
            values
            (
                (0 0)
                (1 0.1)
                (9 0.1)
                (10 0)
            );
        }
    }

Source files

Definition at line 94 of file uniformFixedValueFvFieldSource.H.

Constructor & Destructor Documentation

◆ uniformFixedValueFvFieldSource() [1/2]

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

Construct from internal field and dictionary.

Definition at line 32 of file uniformFixedValueFvFieldSource.C.

◆ uniformFixedValueFvFieldSource() [2/2]

uniformFixedValueFvFieldSource	(	const uniformFixedValueFvFieldSource< Type > &	field,
		const DimensionedField< Type, volMesh > &	iF
	)

Copy constructor setting internal field reference.

Definition at line 53 of file uniformFixedValueFvFieldSource.C.

◆ ~uniformFixedValueFvFieldSource()

~uniformFixedValueFvFieldSource

virtual

Destructor.

Definition at line 67 of file uniformFixedValueFvFieldSource.C.

Member Function Documentation

◆ TypeName()

TypeName ( "uniformFixedValue" )

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 129 of file uniformFixedValueFvFieldSource.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 75 of file uniformFixedValueFvFieldSource.C.

References fvModel::name(), and DimensionedField< Type, GeoMesh, PrimitiveField >::New().

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

Reimplemented from fvFieldSource< Type >.

Definition at line 97 of file uniformFixedValueFvFieldSource.C.

References List< T >::size().

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

virtual

Return the source value.

Implements fvFieldSource< Type >.

Definition at line 118 of file uniformFixedValueFvFieldSource.C.

References Foam::dimless, fvModel::name(), and DimensionedField< Type, GeoMesh, PrimitiveField >::New().

Here is the call graph for this function:

◆ internalCoeff() [2/2]

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

virtual

Return the internal coefficient.

Reimplemented from fvFieldSource< Type >.

Definition at line 136 of file uniformFixedValueFvFieldSource.C.

References List< T >::size().

Here is the call graph for this function:

◆ write()

void write ( Ostream & os ) const

virtual

Write.

Reimplemented from fvFieldSource< Type >.

Definition at line 148 of file uniformFixedValueFvFieldSource.C.

References Foam::dimensions(), fvFieldSource< Type >::write(), and Foam::writeEntry().

Here is the call graph for this function:

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

src/finiteVolume/fields/fvFieldSources/derived/uniformFixedValue/uniformFixedValueFvFieldSource.H
src/finiteVolume/fields/fvFieldSources/derived/uniformFixedValue/uniformFixedValueFvFieldSource.C

Public Member Functions

Additional Inherited Members

Detailed Description

template<class Type> class Foam::uniformFixedValueFvFieldSource< Type >

Constructor & Destructor Documentation

◆ uniformFixedValueFvFieldSource() [1/2]

◆ uniformFixedValueFvFieldSource() [2/2]

◆ ~uniformFixedValueFvFieldSource()

Member Function Documentation

◆ TypeName()

◆ clone()

◆ sourceValue() [1/2]

◆ sourceValue() [2/2]

◆ internalCoeff() [1/2]

◆ internalCoeff() [2/2]

◆ write()

template<class Type>
class Foam::uniformFixedValueFvFieldSource< Type >