patchMeanVelocityForce Class Reference

Calculates and applies the force necessary to maintain the specified mean velocity averaged over the specified patch. More...

Inheritance diagram for patchMeanVelocityForce:
Collaboration diagram for patchMeanVelocityForce:

Public Member Functions

 TypeName ("patchMeanVelocityForce")
 Runtime type information. More...
 
 patchMeanVelocityForce (const word &sourceName, const word &modelType, const dictionary &dict, const fvMesh &mesh)
 Construct from explicit source name and mesh. More...
 
virtual bool read (const dictionary &dict)
 Read dictionary. More...
 
- Public Member Functions inherited from meanVelocityForce
 TypeName ("meanVelocityForce")
 Runtime type information. More...
 
 meanVelocityForce (const word &sourceName, const word &modelType, const dictionary &dict, const fvMesh &mesh)
 Construct from explicit source name and mesh. More...
 
 meanVelocityForce (const meanVelocityForce &)=delete
 Disallow default bitwise copy construction. More...
 
const vector & Ubar () const
 Return the average velocity. More...
 
virtual wordList constrainedFields () const
 Return the list of fields constrained by the fvConstraint. More...
 
virtual bool constrain (fvMatrix< vector > &eqn, const word &fieldName) const
 Add the momentum source and set the 1/A coefficient. More...
 
virtual bool constrain (volVectorField &U) const
 Correct the pressure gradient. More...
 
virtual void updateMesh (const mapPolyMesh &)
 Update for mesh changes. More...
 
void operator= (const meanVelocityForce &)=delete
 Disallow default bitwise assignment. More...
 
- Public Member Functions inherited from fvConstraint
 TypeName ("fvConstraint")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, fvConstraint, dictionary,(const word &name, const word &constraintType, const dictionary &dict, const fvMesh &mesh),(name, constraintType, dict, mesh))
 
 fvConstraint (const word &name, const word &constraintType, const dictionary &dict, const fvMesh &mesh)
 Construct from components. More...
 
autoPtr< fvConstraint > clone () const
 Return clone. More...
 
virtual ~fvConstraint ()
 Destructor. More...
 
const word & name () const
 Return const access to the source name. More...
 
const fvMesh & mesh () const
 Return const access to the mesh database. More...
 
const dictionary & coeffs () const
 Return dictionary. More...
 
virtual bool constrainsField (const word &fieldName) const
 Return true if the given field is constrained. More...
 
 FOR_ALL_FIELD_TYPES (DEFINE_FV_CONSTRAINT_CONSTRAIN)
 Apply a constraint to an equation. More...
 
 FOR_ALL_FIELD_TYPES (DEFINE_FV_CONSTRAINT_CONSTRAIN_FIELD)
 Apply contraint to a field. More...
 
virtual bool movePoints ()
 Update for mesh motion. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from fvConstraint
static autoPtr< fvConstraint > New (const word &name, const dictionary &dict, const fvMesh &mesh)
 Return a reference to the selected fvConstraint. More...
 

Detailed Description

Calculates and applies the force necessary to maintain the specified mean velocity averaged over the specified patch.

Usage
Example usage:
patchMeanVelocityForce1
{
    type            patchMeanVelocityForce;

    selectionMode   all;

    U               U;          // Name of velocity field

    patch           inlet;      // Name of the patch

    Ubar            (10.0 0 0); // Desired mean velocity
    relaxation      0.2;        // Optional relaxation factor
   }
Note
Currently only handles kinematic pressure (incompressible solvers).
Source files

Definition at line 72 of file patchMeanVelocityForce.H.

Constructor & Destructor Documentation

◆ patchMeanVelocityForce()

patchMeanVelocityForce ( const word &  sourceName,
const word &  modelType,
const dictionary &  dict,
const fvMesh &  mesh 
)

Construct from explicit source name and mesh.

Definition at line 67 of file patchMeanVelocityForce.C.

References boundary(), GeometricField< Type, PatchField, GeoMesh >::boundaryField(), forAll, mesh, Foam::normalised(), UPstream::parRun(), patches, patchi, processorCyclicPolyPatch::patchIDs(), Foam::sum(), U, and Ubar().

Here is the call graph for this function:

Member Function Documentation

◆ TypeName()

TypeName ( "patchMeanVelocityForce"  )

Runtime type information.

◆ read()

bool read ( const dictionary &  dict)
virtual

Read dictionary.

Reimplemented from meanVelocityForce.

Definition at line 130 of file patchMeanVelocityForce.C.

References meanVelocityForce::read().

Here is the call graph for this function:

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