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

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

#include <uniformNormalFixedValueFvPatchVectorField.H>

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

Public Member Functions

 TypeName ("uniformNormalFixedValue")
 Runtime type information.
 uniformNormalFixedValueFvPatchVectorField (const fvPatch &, const DimensionedField< vector, volMesh > &)
 Construct from patch and internal field.
 uniformNormalFixedValueFvPatchVectorField (const fvPatch &, const DimensionedField< vector, volMesh > &, const dictionary &)
 Construct from patch, internal field and dictionary.
 uniformNormalFixedValueFvPatchVectorField (const uniformNormalFixedValueFvPatchVectorField &, const fvPatch &, const DimensionedField< vector, volMesh > &, const fvPatchFieldMapper &)
 Construct by mapping given.
 uniformNormalFixedValueFvPatchVectorField (const uniformNormalFixedValueFvPatchVectorField &)
 Construct as copy.
 uniformNormalFixedValueFvPatchVectorField (const uniformNormalFixedValueFvPatchVectorField &, 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 &os) const
 Write.

Detailed Description

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

Usage
Property Description Required Default
uniformValue uniform value yes
ramp time-based ramping no

Example of the boundary condition specification: 

    <patchName>
    {
        type            uniformNormalFixedValue;
        uniformValue    constant -10;          // 10 INTO the domain
    }
Note
Sign conventions:
  • the value is positive for outward-pointing vectors
See also
Foam::Function1Types Foam::fixedValueFvPatchField Foam::surfaceNormalFixedValueFvPatchVectorField Foam::uniformFixedValueFvPatchVectorField
Source files

Definition at line 93 of file uniformNormalFixedValueFvPatchVectorField.H.

Constructor & Destructor Documentation

◆ uniformNormalFixedValueFvPatchVectorField() [1/5]

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

Construct from patch and internal field.

Definition at line 28 of file uniformNormalFixedValueFvPatchVectorField.C.

References p.

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

Here is the caller graph for this function:

◆ uniformNormalFixedValueFvPatchVectorField() [2/5]

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

Construct from patch, internal field and dictionary.

Definition at line 41 of file uniformNormalFixedValueFvPatchVectorField.C.

References dict, Foam::New(), and p.

Here is the call graph for this function:

◆ uniformNormalFixedValueFvPatchVectorField() [3/5]

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

Construct by mapping given.

uniformNormalFixedValueFvPatchVectorField onto a new patch

Definition at line 60 of file uniformNormalFixedValueFvPatchVectorField.C.

References clone(), FieldMapper::direct(), FieldMapper::hasUnmapped(), p, and uniformNormalFixedValueFvPatchVectorField().

Here is the call graph for this function:

◆ uniformNormalFixedValueFvPatchVectorField() [4/5]

uniformNormalFixedValueFvPatchVectorField ( const uniformNormalFixedValueFvPatchVectorField & ptf)

Construct as copy.

Definition at line 86 of file uniformNormalFixedValueFvPatchVectorField.C.

References clone(), and uniformNormalFixedValueFvPatchVectorField().

Here is the call graph for this function:

◆ uniformNormalFixedValueFvPatchVectorField() [5/5]

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

Construct as copy setting internal field reference.

Definition at line 98 of file uniformNormalFixedValueFvPatchVectorField.C.

References clone(), and uniformNormalFixedValueFvPatchVectorField().

Here is the call graph for this function:

Member Function Documentation

◆ TypeName()

TypeName ( "uniformNormalFixedValue" )

Runtime type information.

References uniformNormalFixedValueFvPatchVectorField().

Here is the call graph for this function:

◆ clone() [1/2]

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

Return a clone.

Definition at line 173 of file uniformNormalFixedValueFvPatchVectorField.H.

References fvPatchField< Type >::Clone().

Referenced by uniformNormalFixedValueFvPatchVectorField(), uniformNormalFixedValueFvPatchVectorField(), and uniformNormalFixedValueFvPatchVectorField().

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 181 of file uniformNormalFixedValueFvPatchVectorField.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 113 of file uniformNormalFixedValueFvPatchVectorField.C.

◆ rmap()

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

Reverse map the given fvPatchField onto this fvPatchField.

Definition at line 129 of file uniformNormalFixedValueFvPatchVectorField.C.

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

Here is the call graph for this function:

◆ updateCoeffs()

void updateCoeffs ( )
virtual

Update the coefficients associated with the patch field.

Definition at line 144 of file uniformNormalFixedValueFvPatchVectorField.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 uniformNormalFixedValueFvPatchVectorField.C.

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

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