This source condition provides a uniform fixed value when the source is positive, and the internal value when it is negative (i.e., a sink) More...

Inheritance diagram for uniformInletOutletFvFieldSource< Type >:

[legend]

Collaboration diagram for uniformInletOutletFvFieldSource< Type >:

[legend]

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

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

	uniformInletOutletFvFieldSource (const uniformInletOutletFvFieldSource< 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	~uniformInletOutletFvFieldSource ()
	Destructor. More...

virtual tmp< Field< Type > >	sourceValue (const fvSource &) const
	Return the source value. More...

virtual tmp< scalarField >	internalCoeff (const fvSource &) 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...

tmp< Field< Type > >	sourceCoeff (const fvSource &) const
	Return the source coefficient. More...

tmp< Field< Type > >	value (const fvSource &) const
	Return the value. More...

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

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

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

template<class OtherType >
Foam::tmp< Foam::Field< OtherType > >	value (const word &name, const fvSource &source) 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::uniformInletOutletFvFieldSource< Type >

This source condition provides a uniform fixed value when the source is positive, and the internal value when it is negative (i.e., a sink)

Usage

Property	Description	Required	Default value
`uniformInletValue`	uniform inlet value	yes

Example of the source condition specification with a constant value:

    <patchName>
    {
        type            uniformInletOutlet;
        uniformInletValue 0.1;
    }

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

    <patchName>
    {
        type            uniformInletOutlet;
        uniformInletValue
        {
            type            table;
            values
            (
                (0 0)
                (1 0.1)
                (9 0.1)
                (10 0)
            );
        }
    }

Source files

Definition at line 95 of file uniformInletOutletFvFieldSource.H.

Constructor & Destructor Documentation

◆ uniformInletOutletFvFieldSource() [1/2]

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

Construct from internal field and dictionary.

Definition at line 31 of file uniformInletOutletFvFieldSource.C.

◆ uniformInletOutletFvFieldSource() [2/2]

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

Copy constructor setting internal field reference.

Definition at line 52 of file uniformInletOutletFvFieldSource.C.

◆ ~uniformInletOutletFvFieldSource()

~uniformInletOutletFvFieldSource

virtual

Destructor.

Definition at line 66 of file uniformInletOutletFvFieldSource.C.

Member Function Documentation

◆ TypeName()

TypeName ( "uniformInletOutlet" )

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 130 of file uniformInletOutletFvFieldSource.H.

◆ sourceValue()

Foam::tmp< Foam::Field< Type > > sourceValue ( const fvSource & source ) const

virtual

Return the source value.

Implements fvFieldSource< Type >.

Definition at line 74 of file uniformInletOutletFvFieldSource.C.

References fvSource::nCells().

Here is the call graph for this function:

◆ internalCoeff()

Foam::tmp< Foam::scalarField > internalCoeff ( const fvSource & source ) const

virtual

Return the internal coefficient.

Implements fvFieldSource< Type >.

Definition at line 87 of file uniformInletOutletFvFieldSource.C.

References fvSource::nCells(), Foam::neg0(), and fvSource::source().

Here is the call graph for this function:

◆ write()

void write ( Ostream & os ) const

virtual

Write.

Reimplemented from fvFieldSource< Type >.

Definition at line 99 of file uniformInletOutletFvFieldSource.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/uniformInletOutlet/uniformInletOutletFvFieldSource.H
src/finiteVolume/fields/fvFieldSources/derived/uniformInletOutlet/uniformInletOutletFvFieldSource.C

Public Member Functions

Additional Inherited Members

Detailed Description

template<class Type> class Foam::uniformInletOutletFvFieldSource< Type >

Constructor & Destructor Documentation

◆ uniformInletOutletFvFieldSource() [1/2]

◆ uniformInletOutletFvFieldSource() [2/2]

◆ ~uniformInletOutletFvFieldSource()

Member Function Documentation

◆ TypeName()

◆ clone()

◆ sourceValue()

◆ internalCoeff()

◆ write()

template<class Type>
class Foam::uniformInletOutletFvFieldSource< Type >