Loading...
Searching...
No Matches
surfaceNormalFixedValueFvPatchVectorField Class Reference
Boundary conditions » Generic | Boundary conditions » Inlet

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

#include <surfaceNormalFixedValueFvPatchVectorField.H>

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

Public Member Functions

 TypeName ("surfaceNormalFixedValue")
 Runtime type information.
 surfaceNormalFixedValueFvPatchVectorField (const fvPatch &, const DimensionedField< vector, volMesh > &)
 Construct from patch and internal field.
 surfaceNormalFixedValueFvPatchVectorField (const fvPatch &, const DimensionedField< vector, volMesh > &, const dictionary &)
 Construct from patch, internal field and dictionary.
 surfaceNormalFixedValueFvPatchVectorField (const surfaceNormalFixedValueFvPatchVectorField &, const fvPatch &, const DimensionedField< vector, volMesh > &, const fvPatchFieldMapper &)
 Construct by mapping given.
 surfaceNormalFixedValueFvPatchVectorField (const surfaceNormalFixedValueFvPatchVectorField &)
 Construct as copy.
 surfaceNormalFixedValueFvPatchVectorField (const surfaceNormalFixedValueFvPatchVectorField &, const DimensionedField< vector, volMesh > &)
 Construct as copy setting internal field reference.
virtual tmp< fvPatchField< vector > > clone () const
 Return a clone.
virtual tmp< fvPatchField< vector > > clone (const DimensionedField< vector, volMesh > &iF) const
 Clone with an internal field reference.
virtual void autoMap (const fvPatchFieldMapper &)
 Map (and resize as needed) from self given a mapping object.
virtual void rmap (const fvPatchVectorField &, const labelList &)
 Reverse map the given fvPatchField onto this fvPatchField.
virtual void updateCoeffs ()
 Update the coefficients associated with the patch field.
virtual void write (Ostream &) const
 Write.

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

References p.

Referenced by rmap(), surfaceNormalFixedValueFvPatchVectorField(), surfaceNormalFixedValueFvPatchVectorField(), surfaceNormalFixedValueFvPatchVectorField(), and TypeName().

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

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

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

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

Here is the call graph for this function:

◆ surfaceNormalFixedValueFvPatchVectorField() [4/5]

surfaceNormalFixedValueFvPatchVectorField ( const surfaceNormalFixedValueFvPatchVectorField & ptf)

Construct as copy.

Definition at line 94 of file surfaceNormalFixedValueFvPatchVectorField.C.

References clone(), and surfaceNormalFixedValueFvPatchVectorField().

Here is the call graph for this function:

◆ surfaceNormalFixedValueFvPatchVectorField() [5/5]

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

Construct as copy setting internal field reference.

Definition at line 106 of file surfaceNormalFixedValueFvPatchVectorField.C.

References clone(), and surfaceNormalFixedValueFvPatchVectorField().

Here is the call graph for this function:

Member Function Documentation

◆ TypeName()

TypeName ( "surfaceNormalFixedValue" )

Runtime type information.

References surfaceNormalFixedValueFvPatchVectorField().

Here is the call graph for this function:

◆ clone() [1/2]

virtual tmp< fvPatchField< vector > > clone ( ) const
inlinevirtual

Return a clone.

Definition at line 168 of file surfaceNormalFixedValueFvPatchVectorField.H.

References fvPatchField< Type >::Clone().

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

Here is the call graph for this function:
Here is the caller graph for this function:

◆ clone() [2/2]

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

Clone with an internal field reference.

Definition at line 176 of file surfaceNormalFixedValueFvPatchVectorField.H.

References fvPatchField< Type >::Clone().

Here is the call graph for this function:

◆ autoMap()

void autoMap ( const fvPatchFieldMapper & mapper)
virtual

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

Definition at line 121 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 131 of file surfaceNormalFixedValueFvPatchVectorField.C.

References Foam::refCast(), and surfaceNormalFixedValueFvPatchVectorField().

Here is the call graph for this function:

◆ updateCoeffs()

void updateCoeffs ( )
virtual

Update the coefficients associated with the patch field.

Definition at line 146 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 165 of file surfaceNormalFixedValueFvPatchVectorField.C.

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

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