surfaceNormalFixedValueFvPatchVectorField Class Reference

This boundary condition provides a surface-normal vector boundary condition by its magnitude. More...

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

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 &)
 Construct as copy. More...
 
virtual tmp< fvPatchVectorFieldclone () const
 Construct and return a clone. More...
 
 surfaceNormalFixedValueFvPatchVectorField (const surfaceNormalFixedValueFvPatchVectorField &, const DimensionedField< vector, volMesh > &)
 Construct as copy setting internal field reference. More...
 
virtual tmp< fvPatchVectorFieldclone (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

This boundary condition provides a surface-normal vector boundary condition by its magnitude.

Usage
Property Description Required Default
refValue reference value yes
ramp time-based ramping no

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

Constructor & Destructor Documentation

◆ surfaceNormalFixedValueFvPatchVectorField() [1/5]

Construct from patch and internal field.

Definition at line 36 of file surfaceNormalFixedValueFvPatchVectorField.C.

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

References fvPatchField< vector >::operator=(), and tmp< T >::ref().

Here is the call graph for this function:

◆ surfaceNormalFixedValueFvPatchVectorField() [3/5]

Construct by mapping given.

surfaceNormalFixedValueFvPatchVectorField onto a new patch

Definition at line 72 of file surfaceNormalFixedValueFvPatchVectorField.C.

References fvPatchField< vector >::operator=(), and tmp< T >::ref().

Here is the call graph for this function:

◆ surfaceNormalFixedValueFvPatchVectorField() [4/5]

◆ surfaceNormalFixedValueFvPatchVectorField() [5/5]

Construct as copy setting internal field reference.

Definition at line 113 of file surfaceNormalFixedValueFvPatchVectorField.C.

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

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

◆ autoMap()

void autoMap ( const fvPatchFieldMapper mapper)
virtual

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

Definition at line 128 of file surfaceNormalFixedValueFvPatchVectorField.C.

◆ rmap()

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

Reverse map the given fvPatchField onto this fvPatchField.

Definition at line 138 of file surfaceNormalFixedValueFvPatchVectorField.C.

◆ updateCoeffs()

void updateCoeffs ( )
virtual

Update the coefficients associated with the patch field.

Definition at line 153 of file surfaceNormalFixedValueFvPatchVectorField.C.

References fvPatchField< vector >::operator=(), tmp< T >::ref(), and fvPatchField< vector >::updateCoeffs().

Here is the call graph for this function:

◆ write()

void write ( Ostream os) const
virtual

Write.

Definition at line 172 of file surfaceNormalFixedValueFvPatchVectorField.C.

References os(), and ObukhovLength::write().

Here is the call graph for this function:

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