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 &)=delete
	Disallow copy without setting internal field reference. More...

	interstitialInletVelocityFvPatchVectorField (const interstitialInletVelocityFvPatchVectorField &, const DimensionedField< vector, volMesh > &)
	Copy constructor 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	reset (const fvPatchVectorField &)
	Reset the fvPatchField to the given fvPatchField. More...

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

virtual void	write (Ostream &) const
	Write. 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(), and interstitialInletVelocityFvPatchVectorField::interstitialInletVelocityFvPatchVectorField().

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 49 of file interstitialInletVelocityFvPatchVectorField.C.

References interstitialInletVelocityFvPatchVectorField::interstitialInletVelocityFvPatchVectorField().

Here is the call graph for this function:

◆ 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 63 of file interstitialInletVelocityFvPatchVectorField.C.

References interstitialInletVelocityFvPatchVectorField::interstitialInletVelocityFvPatchVectorField().

Here is the call graph for this function:

◆ interstitialInletVelocityFvPatchVectorField() [4/5]

interstitialInletVelocityFvPatchVectorField ( const interstitialInletVelocityFvPatchVectorField & )

delete

Disallow copy without setting internal field reference.

◆ interstitialInletVelocityFvPatchVectorField() [5/5]

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

Copy constructor setting internal field reference.

Definition at line 78 of file interstitialInletVelocityFvPatchVectorField.C.

References interstitialInletVelocityFvPatchVectorField::autoMap().

Here is the call graph for this function:

Member Function Documentation

◆ TypeName()

TypeName ( "interstitialInletVelocity" )

Runtime type information.

◆ clone()

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

inlinevirtual

Construct and return a clone setting internal field reference.

Definition at line 121 of file interstitialInletVelocityFvPatchVectorField.H.

References interstitialInletVelocityFvPatchVectorField::autoMap(), interstitialInletVelocityFvPatchVectorField::interstitialInletVelocityFvPatchVectorField(), interstitialInletVelocityFvPatchVectorField::reset(), interstitialInletVelocityFvPatchVectorField::rmap(), interstitialInletVelocityFvPatchVectorField::updateCoeffs(), and interstitialInletVelocityFvPatchVectorField::write().

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.

Used to update fields following mesh topology change

Definition at line 92 of file interstitialInletVelocityFvPatchVectorField.C.

References interstitialInletVelocityFvPatchVectorField::rmap().

Referenced by interstitialInletVelocityFvPatchVectorField::clone(), and interstitialInletVelocityFvPatchVectorField::interstitialInletVelocityFvPatchVectorField().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ rmap()

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

virtual

Reverse map the given fvPatchField onto this fvPatchField.

Used to reconstruct fields

Definition at line 102 of file interstitialInletVelocityFvPatchVectorField.C.

References interstitialInletVelocityFvPatchVectorField::reset(), and interstitialInletVelocityFvPatchVectorField::rmap().

Referenced by interstitialInletVelocityFvPatchVectorField::autoMap(), interstitialInletVelocityFvPatchVectorField::clone(), and interstitialInletVelocityFvPatchVectorField::rmap().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ reset()

void reset ( const fvPatchVectorField & ptf )

virtual

Reset the fvPatchField to the given fvPatchField.

Used for mesh to mesh mapping

Definition at line 117 of file interstitialInletVelocityFvPatchVectorField.C.

References interstitialInletVelocityFvPatchVectorField::reset().

Referenced by interstitialInletVelocityFvPatchVectorField::clone(), interstitialInletVelocityFvPatchVectorField::reset(), and interstitialInletVelocityFvPatchVectorField::rmap().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ updateCoeffs()

void updateCoeffs ( )

virtual

Update the coefficients associated with the patch field.

Definition at line 130 of file interstitialInletVelocityFvPatchVectorField.C.

References Foam::operator==().

Referenced by interstitialInletVelocityFvPatchVectorField::clone().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ write()

void write ( Ostream & os ) const

virtual

Write.

Definition at line 145 of file interstitialInletVelocityFvPatchVectorField.C.

References Foam::makePatchTypeField(), fvPatchField< Type >::write(), and Foam::writeEntry().

Referenced by interstitialInletVelocityFvPatchVectorField::clone().

Here is the call graph for this function:

Here is the caller graph for this function:

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

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()

◆ autoMap()

◆ rmap()

◆ reset()

◆ updateCoeffs()

◆ write()