Inlet velocity in which the actual interstitial velocity is calculated by dividing the specified inletVelocity field with the local phase-fraction. More...

Inheritance diagram for interstitialInletVelocityFvPatchVectorField:

[legend]

Collaboration diagram for interstitialInletVelocityFvPatchVectorField:

[legend]

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

	interstitialInletVelocityFvPatchVectorField (const fvPatch &, const DimensionedField< vector, volMesh > &)
	Construct from patch and internal field. More...

	interstitialInletVelocityFvPatchVectorField (const fvPatch &, const DimensionedField< vector, volMesh > &, const dictionary &)
	Construct from patch, internal field and dictionary. More...

	interstitialInletVelocityFvPatchVectorField (const interstitialInletVelocityFvPatchVectorField &, const fvPatch &, const DimensionedField< vector, volMesh > &, const fvPatchFieldMapper &)
	Construct by mapping given. More...

	interstitialInletVelocityFvPatchVectorField (const interstitialInletVelocityFvPatchVectorField &)
	Construct as copy. More...

virtual tmp< fvPatchVectorField >	clone () const
	Construct and return a clone. More...

	interstitialInletVelocityFvPatchVectorField (const interstitialInletVelocityFvPatchVectorField &, const DimensionedField< vector, volMesh > &)
	Construct as copy setting internal field reference. More...

virtual tmp< fvPatchVectorField >	clone (const DimensionedField< vector, volMesh > &iF) const
	Construct and return a clone setting internal field reference. More...

virtual void	autoMap (const fvPatchFieldMapper &)
	Map (and resize as needed) from self given a mapping object. More...

virtual void	rmap (const fvPatchVectorField &, const labelList &)
	Reverse map the given fvPatchField onto this fvPatchField. More...

virtual void	updateCoeffs ()
	Update the coefficients associated with the patch field. More...

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

Private Attributes
vectorField	inletVelocity_
	Inlet velocity. More...

word	alphaName_
	Name of the flux transporting the field. More...

Detailed Description

Inlet velocity in which the actual interstitial velocity is calculated by dividing the specified inletVelocity field with the local phase-fraction.

Example of the boundary condition specification:

inlet
{
    type              interstitialInletVelocity;
    inletVelocity     uniform (0 0.2 0);// Non-interstitial inlet velocity
    alpha             alpha.particles;  // Name of the phase-fraction field
    value             uniform (0 0 0);
}

Source files

Definition at line 59 of file interstitialInletVelocityFvPatchVectorField.H.

Constructor & Destructor Documentation

◆ interstitialInletVelocityFvPatchVectorField() [1/5]

interstitialInletVelocityFvPatchVectorField	(	const fvPatch &	p,
		const DimensionedField< vector, volMesh > &	iF
	)

Construct from patch and internal field.

Definition at line 36 of file interstitialInletVelocityFvPatchVectorField.C.

Referenced by interstitialInletVelocityFvPatchVectorField::clone().

Here is the caller graph for this function:

◆ interstitialInletVelocityFvPatchVectorField() [2/5]

interstitialInletVelocityFvPatchVectorField	(	const fvPatch &	p,
		const DimensionedField< vector, volMesh > &	iF,
		const dictionary &	dict
	)

Construct from patch, internal field and dictionary.

Definition at line 64 of file interstitialInletVelocityFvPatchVectorField.C.

◆ interstitialInletVelocityFvPatchVectorField() [3/5]

interstitialInletVelocityFvPatchVectorField	(	const interstitialInletVelocityFvPatchVectorField &	ptf,
		const fvPatch &	p,
		const DimensionedField< vector, volMesh > &	iF,
		const fvPatchFieldMapper &	mapper
	)

Construct by mapping given.

interstitialInletVelocityFvPatchVectorField onto a new patch

Definition at line 49 of file interstitialInletVelocityFvPatchVectorField.C.

◆ interstitialInletVelocityFvPatchVectorField() [4/5]

interstitialInletVelocityFvPatchVectorField ( const interstitialInletVelocityFvPatchVectorField & ptf )

Construct as copy.

Definition at line 78 of file interstitialInletVelocityFvPatchVectorField.C.

◆ interstitialInletVelocityFvPatchVectorField() [5/5]

interstitialInletVelocityFvPatchVectorField	(	const interstitialInletVelocityFvPatchVectorField &	ptf,
		const DimensionedField< vector, volMesh > &	iF
	)

Construct as copy setting internal field reference.

Definition at line 90 of file interstitialInletVelocityFvPatchVectorField.C.

Member Function Documentation

◆ TypeName()

TypeName ( "interstitialInletVelocity" )

Runtime type information.

◆ clone() [1/2]

virtual tmp<fvPatchVectorField> clone ( ) const

inlinevirtual

Construct and return a clone.

Definition at line 113 of file interstitialInletVelocityFvPatchVectorField.H.

References interstitialInletVelocityFvPatchVectorField::interstitialInletVelocityFvPatchVectorField().

Here is the call graph for this function:

◆ clone() [2/2]

virtual tmp<fvPatchVectorField> clone ( const DimensionedField< vector, volMesh > & iF ) const

inlinevirtual

Construct and return a clone setting internal field reference.

Definition at line 130 of file interstitialInletVelocityFvPatchVectorField.H.

References interstitialInletVelocityFvPatchVectorField::interstitialInletVelocityFvPatchVectorField().

Here is the call graph for this function:

◆ autoMap()

void autoMap ( const fvPatchFieldMapper & m )

virtual

Map (and resize as needed) from self given a mapping object.

Definition at line 104 of file interstitialInletVelocityFvPatchVectorField.C.

◆ rmap()

void rmap	(	const fvPatchVectorField &	ptf,
		const labelList &	addr
	)

virtual

Reverse map the given fvPatchField onto this fvPatchField.

Definition at line 114 of file interstitialInletVelocityFvPatchVectorField.C.

References interstitialInletVelocityFvPatchVectorField::inletVelocity_.

◆ updateCoeffs()

void updateCoeffs ( )

virtual

Update the coefficients associated with the patch field.

Definition at line 128 of file interstitialInletVelocityFvPatchVectorField.C.

References interstitialInletVelocityFvPatchVectorField::alphaName_, interstitialInletVelocityFvPatchVectorField::inletVelocity_, and Foam::operator==().

Here is the call graph for this function:

◆ write()

void write ( Ostream & os ) const

virtual

Write.

Definition at line 143 of file interstitialInletVelocityFvPatchVectorField.C.

References fvPatchField::write().

Here is the call graph for this function:

Field Documentation

◆ inletVelocity_

vectorField inletVelocity_

private

Inlet velocity.

Definition at line 66 of file interstitialInletVelocityFvPatchVectorField.H.

Referenced by interstitialInletVelocityFvPatchVectorField::rmap(), and interstitialInletVelocityFvPatchVectorField::updateCoeffs().

◆ alphaName_

word alphaName_

private

Name of the flux transporting the field.

Definition at line 69 of file interstitialInletVelocityFvPatchVectorField.H.

Referenced by interstitialInletVelocityFvPatchVectorField::updateCoeffs().

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

src/finiteVolume/fields/fvPatchFields/derived/interstitialInletVelocity/interstitialInletVelocityFvPatchVectorField.H
src/finiteVolume/fields/fvPatchFields/derived/interstitialInletVelocity/interstitialInletVelocityFvPatchVectorField.C

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ interstitialInletVelocityFvPatchVectorField() [1/5]

◆ interstitialInletVelocityFvPatchVectorField() [2/5]

◆ interstitialInletVelocityFvPatchVectorField() [3/5]

◆ interstitialInletVelocityFvPatchVectorField() [4/5]

◆ interstitialInletVelocityFvPatchVectorField() [5/5]

Member Function Documentation

◆ TypeName()

◆ clone() [1/2]

◆ clone() [2/2]

◆ autoMap()

◆ rmap()

◆ updateCoeffs()

◆ write()

Field Documentation

◆ inletVelocity_

◆ alphaName_