Public Member Functions | List of all members
surfaceNormalFixedValueFvPatchVectorField Class Reference

This boundary condition provides a surface-normal vector boundary condition by its magnitude. 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 > &)
 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.


Patch usage

Property Description Required Default value
refValue reference value yes

Example of the boundary condition specification:

    myPatch
    {
        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 86 of file surfaceNormalFixedValueFvPatchVectorField.H.

Constructor & Destructor Documentation

Construct from patch and internal field.

Definition at line 35 of file surfaceNormalFixedValueFvPatchVectorField.C.

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

Here is the caller graph for this function:

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

Construct from patch, internal field and dictionary.

Definition at line 72 of file surfaceNormalFixedValueFvPatchVectorField.C.

References surfaceNormalFixedValueFvPatchVectorField::surfaceNormalFixedValueFvPatchVectorField().

Here is the call graph for this function:

Construct by mapping given.

surfaceNormalFixedValueFvPatchVectorField onto a new patch

Definition at line 47 of file surfaceNormalFixedValueFvPatchVectorField.C.

References surfaceNormalFixedValueFvPatchVectorField::surfaceNormalFixedValueFvPatchVectorField(), and vectorField().

Here is the call graph for this function:

Construct as copy.

Definition at line 87 of file surfaceNormalFixedValueFvPatchVectorField.C.

References surfaceNormalFixedValueFvPatchVectorField::surfaceNormalFixedValueFvPatchVectorField().

Here is the call graph for this function:

Construct as copy setting internal field reference.

Definition at line 98 of file surfaceNormalFixedValueFvPatchVectorField.C.

References surfaceNormalFixedValueFvPatchVectorField::autoMap().

Here is the call graph for this function:

Member Function Documentation

TypeName ( "surfaceNormalFixedValue"  )

Runtime type information.

virtual tmp<fvPatchVectorField> clone ( ) const
inlinevirtual

Construct and return a clone.

Definition at line 136 of file surfaceNormalFixedValueFvPatchVectorField.H.

References surfaceNormalFixedValueFvPatchVectorField::surfaceNormalFixedValueFvPatchVectorField().

Here is the call graph for this function:

virtual tmp<fvPatchVectorField> clone ( const DimensionedField< vector, volMesh > &  iF) const
inlinevirtual
void autoMap ( const fvPatchFieldMapper m)
virtual

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

Definition at line 111 of file surfaceNormalFixedValueFvPatchVectorField.C.

References surfaceNormalFixedValueFvPatchVectorField::rmap().

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

Here is the call graph for this function:

Here is the caller graph for this function:

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

Reverse map the given fvPatchField onto this fvPatchField.

Definition at line 121 of file surfaceNormalFixedValueFvPatchVectorField.C.

References surfaceNormalFixedValueFvPatchVectorField::rmap().

Referenced by surfaceNormalFixedValueFvPatchVectorField::autoMap(), surfaceNormalFixedValueFvPatchVectorField::clone(), and surfaceNormalFixedValueFvPatchVectorField::rmap().

Here is the call graph for this function:

Here is the caller graph for this function:

void updateCoeffs ( )
virtual

Update the coefficients associated with the patch field.

Definition at line 135 of file surfaceNormalFixedValueFvPatchVectorField.C.

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

Referenced by surfaceNormalFixedValueFvPatchVectorField::clone().

Here is the call graph for this function:

Here is the caller graph for this function:

void write ( Ostream os) const
virtual

Write.

Definition at line 147 of file surfaceNormalFixedValueFvPatchVectorField.C.

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

Referenced by surfaceNormalFixedValueFvPatchVectorField::clone().

Here is the call graph for this function:

Here is the caller graph for this function:


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