Public Member Functions | List of all members
surfaceNormalUniformFixedValueFvPatchVectorField Class Reference

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

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

Public Member Functions

 TypeName ("surfaceNormalUniformFixedValue")
 Runtime type information. More...
 
 surfaceNormalUniformFixedValueFvPatchVectorField (const fvPatch &, const DimensionedField< vector, volMesh > &, const dictionary &)
 Construct from patch, internal field and dictionary. More...
 
 surfaceNormalUniformFixedValueFvPatchVectorField (const surfaceNormalUniformFixedValueFvPatchVectorField &, const fvPatch &, const DimensionedField< vector, volMesh > &, const fieldMapper &)
 Construct by mapping given. More...
 
 surfaceNormalUniformFixedValueFvPatchVectorField (const surfaceNormalUniformFixedValueFvPatchVectorField &)=delete
 Disallow copy without setting internal field reference. More...
 
 surfaceNormalUniformFixedValueFvPatchVectorField (const surfaceNormalUniformFixedValueFvPatchVectorField &, 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 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 evaluated scalar Function1 provided.

Usage
Property Description Required Default value
uniformValue uniform value yes

Example of the boundary condition specification: 

    <patchName>
    {
        type            surfaceNormalUniformFixedValue;
        uniformValue    constant -0.2;         // 0.2 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 surfaceNormalUniformFixedValueFvPatchVectorField.H.

Constructor & Destructor Documentation

◆ surfaceNormalUniformFixedValueFvPatchVectorField() [1/4]

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

Construct from patch, internal field and dictionary.

Definition at line 33 of file surfaceNormalUniformFixedValueFvPatchVectorField.C.

References Foam::evaluate().

Here is the call graph for this function:

◆ surfaceNormalUniformFixedValueFvPatchVectorField() [2/4]

surfaceNormalUniformFixedValueFvPatchVectorField ( const surfaceNormalUniformFixedValueFvPatchVectorField &  pvf,
const fvPatch &  p,
const DimensionedField< vector, volMesh > &  iF,
const fieldMapper &  mapper 
)

Construct by mapping given.

surfaceNormalUniformFixedValueFvPatchVectorField onto a new patch

Definition at line 57 of file surfaceNormalUniformFixedValueFvPatchVectorField.C.

References Foam::evaluate().

Here is the call graph for this function:

◆ surfaceNormalUniformFixedValueFvPatchVectorField() [3/4]

surfaceNormalUniformFixedValueFvPatchVectorField ( const surfaceNormalUniformFixedValueFvPatchVectorField &  )
delete

Disallow copy without setting internal field reference.

◆ surfaceNormalUniformFixedValueFvPatchVectorField() [4/4]

surfaceNormalUniformFixedValueFvPatchVectorField ( const surfaceNormalUniformFixedValueFvPatchVectorField &  pvf,
const DimensionedField< vector, volMesh > &  iF 
)

Copy constructor setting internal field reference.

Definition at line 74 of file surfaceNormalUniformFixedValueFvPatchVectorField.C.

References Foam::evaluate().

Here is the call graph for this function:

Member Function Documentation

◆ TypeName()

TypeName ( "surfaceNormalUniformFixedValue"  )

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 surfaceNormalUniformFixedValueFvPatchVectorField.H.

◆ updateCoeffs()

void updateCoeffs ( )
virtual

Update the coefficients associated with the patch field.

Definition at line 94 of file surfaceNormalUniformFixedValueFvPatchVectorField.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 110 of file surfaceNormalUniformFixedValueFvPatchVectorField.C.

References Foam::dimensions(), 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: