This boundary condition provides a generic outflow condition, with specified inflow for the case of return flow. More...

Inheritance diagram for inletOutletFvPatchField< Type >:

[legend]

Collaboration diagram for inletOutletFvPatchField< Type >:

[legend]

Public Member Functions
	TypeName ("inletOutlet")

	inletOutletFvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &)

	inletOutletFvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const dictionary &)

	inletOutletFvPatchField (const inletOutletFvPatchField< Type > &, const fvPatch &, const DimensionedField< Type, volMesh > &, const fvPatchFieldMapper &)

	inletOutletFvPatchField (const inletOutletFvPatchField< Type > &)

virtual tmp< fvPatchField< Type > >	clone () const

	inletOutletFvPatchField (const inletOutletFvPatchField< Type > &, const DimensionedField< Type, volMesh > &)

virtual tmp< fvPatchField< Type > >	clone (const DimensionedField< Type, volMesh > &iF) const

virtual bool	assignable () const

virtual void	updateCoeffs ()

virtual void	write (Ostream &) const

virtual void	operator= (const fvPatchField< Type > &pvf)

Public Member Functions inherited from mixedFvPatchField< Type >
	TypeName ("mixed")

	mixedFvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &)

	mixedFvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const dictionary &)

	mixedFvPatchField (const mixedFvPatchField< Type > &, const fvPatch &, const DimensionedField< Type, volMesh > &, const fvPatchFieldMapper &)

	mixedFvPatchField (const mixedFvPatchField< Type > &)

	mixedFvPatchField (const mixedFvPatchField< Type > &, const DimensionedField< Type, volMesh > &)

virtual bool	fixesValue () const

virtual Field< Type > &	refValue ()

virtual const Field< Type > &	refValue () const

virtual Field< Type > &	refGrad ()

virtual const Field< Type > &	refGrad () const

virtual scalarField &	valueFraction ()

virtual const scalarField &	valueFraction () const

virtual Field< Type > &	source ()

virtual const Field< Type > &	source () const

virtual void	autoMap (const fvPatchFieldMapper &)

virtual void	rmap (const fvPatchField< Type > &, const labelList &)

virtual tmp< Field< Type > >	snGrad () const

virtual void	evaluate (const Pstream::commsTypes commsType=Pstream::commsTypes::blocking)

virtual tmp< Field< Type > >	valueInternalCoeffs (const tmp< scalarField > &) const

virtual tmp< Field< Type > >	valueBoundaryCoeffs (const tmp< scalarField > &) const

virtual tmp< Field< Type > >	gradientInternalCoeffs () const

virtual tmp< Field< Type > >	gradientBoundaryCoeffs () const

virtual void	operator= (const UList< Type > &)

virtual void	operator+= (const fvPatchField< Type > &)

virtual void	operator-= (const fvPatchField< Type > &)

virtual void	operator*= (const fvPatchField< scalar > &)

virtual void	operator/= (const fvPatchField< scalar > &)

virtual void	operator+= (const Field< Type > &)

virtual void	operator-= (const Field< Type > &)

virtual void	operator*= (const Field< scalar > &)

virtual void	operator/= (const Field< scalar > &)

virtual void	operator= (const Type &)

virtual void	operator+= (const Type &)

virtual void	operator-= (const Type &)

virtual void	operator*= (const scalar)

virtual void	operator/= (const scalar)

Public Member Functions inherited from fvPatchField< Type >
	TypeName ("fvPatchField")

	declareRunTimeSelectionTable (tmp, fvPatchField, patch,(const fvPatch &p, const DimensionedField< Type, volMesh > &iF),(p, iF))

	declareRunTimeSelectionTable (tmp, fvPatchField, patchMapper,(const fvPatchField< Type > &ptf, const fvPatch &p, const DimensionedField< Type, volMesh > &iF, const fvPatchFieldMapper &m),(dynamic_cast< const fvPatchFieldType & >(ptf), p, iF, m))

	declareRunTimeSelectionTable (tmp, fvPatchField, dictionary,(const fvPatch &p, const DimensionedField< Type, volMesh > &iF, const dictionary &dict),(p, iF, dict))

	fvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &)

	fvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const Type &value)

	fvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const word &patchType)

	fvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const Field< Type > &)

	fvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const dictionary &, const bool valueRequired=true)

	fvPatchField (const fvPatchField< Type > &, const fvPatch &, const DimensionedField< Type, volMesh > &, const fvPatchFieldMapper &)

	fvPatchField (const fvPatchField< Type > &)

	fvPatchField (const fvPatchField< Type > &, const DimensionedField< Type, volMesh > &)

virtual tmp< fvPatchField< Type > >	clone () const

Foam::tmp< Foam::fvPatchField< Type > >	NewCalculatedType (const fvPatch &p)

Foam::tmp< Foam::fvPatchField< Type > >	NewCalculatedType (const fvPatchField< Type2 > &pf)

virtual	~fvPatchField ()=default

bool	useImplicit () const noexcept

bool	useImplicit (bool on) noexcept

virtual bool	fixesValue () const

virtual bool	assignable () const

virtual bool	coupled () const

const objectRegistry &	db () const

const fvPatch &	patch () const

const DimensionedField< Type, volMesh > &	internalField () const

const Field< Type > &	primitiveField () const

const word &	patchType () const

word &	patchType ()

bool	updated () const

bool	manipulatedMatrix () const

virtual tmp< Field< Type > >	snGrad () const

virtual tmp< Field< Type > >	snGrad (const scalarField &deltaCoeffs) const

virtual void	updateWeightedCoeffs (const scalarField &weights)

virtual tmp< Field< Type > >	patchInternalField () const

virtual void	patchInternalField (Field< Type > &) const

virtual tmp< Field< Type > >	patchNeighbourField () const

virtual void	initEvaluate (const Pstream::commsTypes commsType=Pstream::commsTypes::blocking)

virtual tmp< Field< Type > >	valueInternalCoeffs (const tmp< Field< scalar >> &) const

virtual tmp< Field< Type > >	valueBoundaryCoeffs (const tmp< Field< scalar >> &) const

virtual tmp< Field< Type > >	gradientInternalCoeffs () const

virtual tmp< Field< Type > >	gradientInternalCoeffs (const scalarField &deltaCoeffs) const

virtual tmp< Field< Type > >	gradientBoundaryCoeffs () const

virtual tmp< Field< Type > >	gradientBoundaryCoeffs (const scalarField &deltaCoeffs) const

virtual void	manipulateMatrix (fvMatrix< Type > &matrix)

virtual void	manipulateMatrix (fvMatrix< Type > &matrix, const scalarField &weights)

virtual void	manipulateMatrix (fvMatrix< Type > &matrix, const label iMatrix, const direction cmp)

void	check (const fvPatchField< Type > &) const

virtual void	operator== (const fvPatchField< Type > &)

virtual void	operator== (const Field< Type > &)

virtual void	operator== (const Type &)

Protected Attributes
word	phiName_

Additional Inherited Members
Public Types inherited from fvPatchField< Type >
typedef fvPatch	Patch

typedef calculatedFvPatchField< Type >	Calculated

Static Public Member Functions inherited from fvPatchField< Type >
static tmp< fvPatchField< Type > >	New (const word &, const fvPatch &, const DimensionedField< Type, volMesh > &)

static tmp< fvPatchField< Type > >	New (const word &, const word &actualPatchType, const fvPatch &, const DimensionedField< Type, volMesh > &)

static tmp< fvPatchField< Type > >	New (const fvPatchField< Type > &, const fvPatch &, const DimensionedField< Type, volMesh > &, const fvPatchFieldMapper &)

static tmp< fvPatchField< Type > >	New (const fvPatch &, const DimensionedField< Type, volMesh > &, const dictionary &)

static tmp< fvPatchField< Type > >	NewCalculatedType (const fvPatch &)

static tmp< fvPatchField< Type > >	NewCalculatedType (const fvPatchField< Type2 > &)

static const word &	calculatedType ()

Static Public Attributes inherited from fvPatchField< Type >
static int	disallowGenericFvPatchField

Detailed Description

template<class Type>
class Foam::inletOutletFvPatchField< Type >

This boundary condition provides a generic outflow condition, with specified inflow for the case of return flow.

Usage

Property	Description	Required	Default value
`phi`	Flux field name	no	phi
`inletValue`	Inlet value for reverse flow	yes

Example of the boundary condition specification:

    <patchName>
    {
        type            inletOutlet;
        phi             phi;
        inletValue      uniform 0;
        value           uniform 0;
    }

The mode of operation is determined by the sign of the flux across the patch faces.

Note

Sign conventions:

Positive flux (out of domain): apply zero-gradient condition
Negative flux (into of domain): apply the "inletValue" fixed-value

See also: Foam::mixedFvPatchField Foam::zeroGradientFvPatchField Foam::outletInletFvPatchField

Source files

Definition at line 97 of file inletOutletFvPatchField.H.

Constructor & Destructor Documentation

◆ inletOutletFvPatchField() [1/5]

inletOutletFvPatchField	(	const fvPatch &	p,
		const DimensionedField< Type, volMesh > &	iF
	)

Definition at line 28 of file inletOutletFvPatchField.C.

References Foam::Zero.

◆ inletOutletFvPatchField() [2/5]

inletOutletFvPatchField	(	const fvPatch &	p,
		const DimensionedField< Type, volMesh > &	iF,
		const dictionary &	dict
	)

Definition at line 58 of file inletOutletFvPatchField.C.

References dict, p, and Foam::Zero.

◆ inletOutletFvPatchField() [3/5]

inletOutletFvPatchField	(	const inletOutletFvPatchField< Type > &	ptf,
		const fvPatch &	p,
		const DimensionedField< Type, volMesh > &	iF,
		const fvPatchFieldMapper &	mapper
	)

Definition at line 44 of file inletOutletFvPatchField.C.

◆ inletOutletFvPatchField() [4/5]

inletOutletFvPatchField ( const inletOutletFvPatchField< Type > & ptf )

Definition at line 90 of file inletOutletFvPatchField.C.

◆ inletOutletFvPatchField() [5/5]

inletOutletFvPatchField	(	const inletOutletFvPatchField< Type > &	ptf,
		const DimensionedField< Type, volMesh > &	iF
	)

Definition at line 101 of file inletOutletFvPatchField.C.

Member Function Documentation

◆ TypeName()

TypeName ( "inletOutlet" )

◆ clone() [1/2]

virtual tmp<fvPatchField<Type> > clone ( ) const

inlinevirtual

Reimplemented from mixedFvPatchField< Type >.

Reimplemented in freestreamFvPatchField< Type >.

Definition at line 149 of file inletOutletFvPatchField.H.

◆ clone() [2/2]

virtual tmp<fvPatchField<Type> > clone ( const DimensionedField< Type, volMesh > & iF ) const

inlinevirtual

Reimplemented from mixedFvPatchField< Type >.

Reimplemented in freestreamFvPatchField< Type >.

Definition at line 166 of file inletOutletFvPatchField.H.

◆ assignable()

virtual bool assignable ( ) const

inlinevirtual

Reimplemented from mixedFvPatchField< Type >.

Definition at line 182 of file inletOutletFvPatchField.H.

◆ updateCoeffs()

void updateCoeffs

virtual

Reimplemented from fvPatchField< Type >.

Reimplemented in freestreamFvPatchField< Type >.

Definition at line 114 of file inletOutletFvPatchField.C.

References Foam::foamVersion::patch, and Foam::pos0().

Here is the call graph for this function:

◆ write()

void write ( Ostream & os ) const

virtual

Reimplemented from mixedFvPatchField< Type >.

Reimplemented in freestreamFvPatchField< Type >.

Definition at line 134 of file inletOutletFvPatchField.C.

References os(), and Foam::vtk::write().

Here is the call graph for this function:

◆ operator=()

void operator= ( const fvPatchField< Type > & pvf )

virtual

Reimplemented from mixedFvPatchField< Type >.

Definition at line 147 of file inletOutletFvPatchField.C.

Member Data Documentation

◆ phiName_

word phiName_

protected

Definition at line 107 of file inletOutletFvPatchField.H.

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

src/finiteVolume/fields/fvPatchFields/derived/inletOutlet/inletOutletFvPatchField.H
src/finiteVolume/fields/fvPatchFields/derived/inletOutlet/inletOutletFvPatchField.C

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

template<class Type> class Foam::inletOutletFvPatchField< Type >

Constructor & Destructor Documentation

◆ inletOutletFvPatchField() [1/5]

◆ inletOutletFvPatchField() [2/5]

◆ inletOutletFvPatchField() [3/5]

◆ inletOutletFvPatchField() [4/5]

◆ inletOutletFvPatchField() [5/5]

Member Function Documentation

◆ TypeName()

◆ clone() [1/2]

◆ clone() [2/2]

◆ assignable()

◆ updateCoeffs()

◆ write()

◆ operator=()

Member Data Documentation

◆ phiName_

template<class Type>
class Foam::inletOutletFvPatchField< Type >