Public Member Functions | List of all members
surfaceNormalFixedValueFvPatchVectorField Class Reference

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

Inheritance diagram for surfaceNormalFixedValueFvPatchVectorField:
Inheritance graph
[legend]
Collaboration diagram for surfaceNormalFixedValueFvPatchVectorField:
Collaboration graph
[legend]

Public Member Functions

 TypeName ("surfaceNormalFixedValue")
 Runtime type information. 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 fieldMapper &)
 Construct by mapping given. More...
 
 surfaceNormalFixedValueFvPatchVectorField (const surfaceNormalFixedValueFvPatchVectorField &)=delete
 Disallow copy without setting internal field reference. 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 map (const fvPatchVectorField &, const fieldMapper &)
 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

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/4]

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

Construct from patch, internal field and dictionary.

Definition at line 33 of file surfaceNormalFixedValueFvPatchVectorField.C.

References fvPatchField< Type >::operator=().

Here is the call graph for this function:

◆ surfaceNormalFixedValueFvPatchVectorField() [2/4]

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

Construct by mapping given.

surfaceNormalFixedValueFvPatchVectorField onto a new patch

Definition at line 48 of file surfaceNormalFixedValueFvPatchVectorField.C.

References fvPatchField< Type >::operator.

◆ surfaceNormalFixedValueFvPatchVectorField() [3/4]

surfaceNormalFixedValueFvPatchVectorField ( const surfaceNormalFixedValueFvPatchVectorField &  )
delete

Disallow copy without setting internal field reference.

◆ surfaceNormalFixedValueFvPatchVectorField() [4/4]

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

Copy constructor setting internal field reference.

Definition at line 69 of file surfaceNormalFixedValueFvPatchVectorField.C.

Member Function Documentation

◆ TypeName()

TypeName ( "surfaceNormalFixedValue"  )

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

◆ map()

void map ( const fvPatchVectorField &  ptf,
const fieldMapper &  mapper 
)
virtual

Map the given fvPatchField onto this fvPatchField.

Definition at line 83 of file surfaceNormalFixedValueFvPatchVectorField.C.

◆ reset()

void reset ( const fvPatchVectorField &  ptf)
virtual

Reset the fvPatchField to the given fvPatchField.

Used for mesh to mesh mapping

Definition at line 98 of file surfaceNormalFixedValueFvPatchVectorField.C.

◆ updateCoeffs()

void updateCoeffs ( )
virtual

Update the coefficients associated with the patch field.

Definition at line 112 of file surfaceNormalFixedValueFvPatchVectorField.C.

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

Here is the call graph for this function:

◆ write()

void write ( Ostream &  os) const
virtual

Write.

Definition at line 124 of file surfaceNormalFixedValueFvPatchVectorField.C.

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

Here is the call graph for this function:
The documentation for this class was generated from the following files: