Surface-normal fixed value vector boundary condition. More...

Inheritance diagram for surfaceNormalFixedValueFvPatchVectorField:

Collaboration diagram for surfaceNormalFixedValueFvPatchVectorField:

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

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

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

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

	surfaceNormalFixedValueFvPatchVectorField (const surfaceNormalFixedValueFvPatchVectorField &)
	Copy constructor. More...

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

	surfaceNormalFixedValueFvPatchVectorField (const surfaceNormalFixedValueFvPatchVectorField &, 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	updateCoeffs ()
	Update the coefficients associated with the patch field. More...

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

Detailed Description

Surface-normal fixed value vector boundary condition.

in which the vector field is obtained by scaling the patch normals by the scalar field provided.

Usage

Property	Description	Required	Default value
`refValue`	reference value	yes

Example of the boundary condition specification:

    <patchName>
    {
        type            surfaceNormalFixedValue;
        refValue        uniform -10;           // 10 INTO the domain
    }

Note

Sign conventions:

the value is positive for outward-pointing vectors

See also: Foam::fixedValueFvPatchField

Source files

Definition at line 84 of file surfaceNormalFixedValueFvPatchVectorField.H.

Constructor & Destructor Documentation

◆ surfaceNormalFixedValueFvPatchVectorField() [1/5]

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

Construct from patch and internal field.

Definition at line 35 of file surfaceNormalFixedValueFvPatchVectorField.C.

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

Here is the caller graph for this function:

◆ surfaceNormalFixedValueFvPatchVectorField() [2/5]

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

Construct from patch, internal field and dictionary.

Definition at line 47 of file surfaceNormalFixedValueFvPatchVectorField.C.

References surfaceNormalFixedValueFvPatchVectorField::surfaceNormalFixedValueFvPatchVectorField().

Here is the call graph for this function:

◆ surfaceNormalFixedValueFvPatchVectorField() [3/5]

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

Construct by mapping given.

surfaceNormalFixedValueFvPatchVectorField onto a new patch

Definition at line 62 of file surfaceNormalFixedValueFvPatchVectorField.C.

References surfaceNormalFixedValueFvPatchVectorField::surfaceNormalFixedValueFvPatchVectorField().

Here is the call graph for this function:

◆ surfaceNormalFixedValueFvPatchVectorField() [4/5]

surfaceNormalFixedValueFvPatchVectorField ( const surfaceNormalFixedValueFvPatchVectorField & pivpvf )

Copy constructor.

Definition at line 83 of file surfaceNormalFixedValueFvPatchVectorField.C.

References surfaceNormalFixedValueFvPatchVectorField::surfaceNormalFixedValueFvPatchVectorField().

Here is the call graph for this function:

◆ surfaceNormalFixedValueFvPatchVectorField() [5/5]

surfaceNormalFixedValueFvPatchVectorField	(	const surfaceNormalFixedValueFvPatchVectorField &	pivpvf,
		const DimensionedField< vector, volMesh > &	iF
	)

Copy constructor setting internal field reference.

Definition at line 94 of file surfaceNormalFixedValueFvPatchVectorField.C.

References surfaceNormalFixedValueFvPatchVectorField::autoMap().

Here is the call graph for this function:

Member Function Documentation

◆ TypeName()

TypeName ( "surfaceNormalFixedValue" )

Runtime type information.

◆ clone() [1/2]

virtual tmp<fvPatchVectorField> clone ( ) const

inlinevirtual

Construct and return a clone.

Definition at line 134 of file surfaceNormalFixedValueFvPatchVectorField.H.

References surfaceNormalFixedValueFvPatchVectorField::surfaceNormalFixedValueFvPatchVectorField().

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 151 of file surfaceNormalFixedValueFvPatchVectorField.H.

References surfaceNormalFixedValueFvPatchVectorField::autoMap(), surfaceNormalFixedValueFvPatchVectorField::rmap(), surfaceNormalFixedValueFvPatchVectorField::surfaceNormalFixedValueFvPatchVectorField(), surfaceNormalFixedValueFvPatchVectorField::updateCoeffs(), and surfaceNormalFixedValueFvPatchVectorField::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 107 of file surfaceNormalFixedValueFvPatchVectorField.C.

References surfaceNormalFixedValueFvPatchVectorField::rmap().

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

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 117 of file surfaceNormalFixedValueFvPatchVectorField.C.

References surfaceNormalFixedValueFvPatchVectorField::rmap().

Referenced by surfaceNormalFixedValueFvPatchVectorField::autoMap(), surfaceNormalFixedValueFvPatchVectorField::clone(), and surfaceNormalFixedValueFvPatchVectorField::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 131 of file surfaceNormalFixedValueFvPatchVectorField.C.

References fvPatchField< Type >::operator=(), and fvPatchField< Type >::updateCoeffs().

Referenced by surfaceNormalFixedValueFvPatchVectorField::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 143 of file surfaceNormalFixedValueFvPatchVectorField.C.

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

Referenced by surfaceNormalFixedValueFvPatchVectorField::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/surfaceNormalFixedValue/surfaceNormalFixedValueFvPatchVectorField.H
src/finiteVolume/fields/fvPatchFields/derived/surfaceNormalFixedValue/surfaceNormalFixedValueFvPatchVectorField.C

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ surfaceNormalFixedValueFvPatchVectorField() [1/5]

◆ surfaceNormalFixedValueFvPatchVectorField() [2/5]

◆ surfaceNormalFixedValueFvPatchVectorField() [3/5]

◆ surfaceNormalFixedValueFvPatchVectorField() [4/5]

◆ surfaceNormalFixedValueFvPatchVectorField() [5/5]

Member Function Documentation

◆ TypeName()

◆ clone() [1/2]

◆ clone() [2/2]

◆ autoMap()

◆ rmap()

◆ updateCoeffs()

◆ write()