Public Member Functions | List of all members
fixedShearStressFvPatchVectorField Class Reference
Turbulence models » Boundary conditions

This boundary condition sets a user-defined shear stress constant and uniform across a given patch by using the expression: More...

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

Public Member Functions

 TypeName ("fixedShearStress")
 Runtime type information. More...
 
 fixedShearStressFvPatchVectorField (const fvPatch &, const DimensionedField< vector, volMesh > &)
 Construct from patch and internal field. More...
 
 fixedShearStressFvPatchVectorField (const fvPatch &, const DimensionedField< vector, volMesh > &, const dictionary &)
 Construct from patch, internal field and dictionary. More...
 
 fixedShearStressFvPatchVectorField (const fixedShearStressFvPatchVectorField &, const fvPatch &, const DimensionedField< vector, volMesh > &, const fvPatchFieldMapper &)
 Construct by mapping given. More...
 
 fixedShearStressFvPatchVectorField (const fixedShearStressFvPatchVectorField &)
 Construct as copy. More...
 
 fixedShearStressFvPatchVectorField (const fixedShearStressFvPatchVectorField &, const DimensionedField< vector, volMesh > &)
 Construct as copy setting internal field reference. More...
 
virtual tmp< fvPatchField< vector > > clone () const
 Return a clone. More...
 
virtual tmp< fvPatchField< vector > > clone (const DimensionedField< vector, volMesh > &iF) const
 Clone with an 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

This boundary condition sets a user-defined shear stress constant and uniform across a given patch by using the expression:

\[ tau_0 = -\nu_{eff} \frac{dU}{dn} \]

Usage
Example of the boundary condition specification: 
<patchName>
{
    // Mandatory entries
    type             fixedShearStress;
    tau              <vector>;

    // Inherited entries
    ...
}

where the entries mean:

Property Description Type Reqd Deflt
type Type name: fixedShearStress word yes -
tau Shear stress vector yes -

The inherited entries are elaborated in:

Source files

Definition at line 98 of file fixedShearStressFvPatchVectorField.H.

Constructor & Destructor Documentation

◆ fixedShearStressFvPatchVectorField() [1/5]

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

Construct from patch and internal field.

Definition at line 32 of file fixedShearStressFvPatchVectorField.C.

◆ fixedShearStressFvPatchVectorField() [2/5]

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

Construct from patch, internal field and dictionary.

Definition at line 43 of file fixedShearStressFvPatchVectorField.C.

◆ fixedShearStressFvPatchVectorField() [3/5]

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

Construct by mapping given.

Definition at line 57 of file fixedShearStressFvPatchVectorField.C.

◆ fixedShearStressFvPatchVectorField() [4/5]

fixedShearStressFvPatchVectorField ( const fixedShearStressFvPatchVectorField &  ptf)

Construct as copy.

Definition at line 70 of file fixedShearStressFvPatchVectorField.C.

◆ fixedShearStressFvPatchVectorField() [5/5]

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

Construct as copy setting internal field reference.

Definition at line 80 of file fixedShearStressFvPatchVectorField.C.

Member Function Documentation

◆ TypeName()

TypeName ( "fixedShearStress"  )

Runtime type information.

◆ clone() [1/2]

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

Return a clone.

Definition at line 170 of file fixedShearStressFvPatchVectorField.H.

References fvPatchField< Type >::Clone().

Here is the call 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 179 of file fixedShearStressFvPatchVectorField.H.

References fvPatchField< Type >::Clone().

Here is the call graph for this function:

◆ updateCoeffs()

void updateCoeffs ( )
virtual

Update the coefficients associated with the patch field.

Definition at line 92 of file fixedShearStressFvPatchVectorField.C.

References Foam::constant::atomic::group, IOobject::groupName(), Foam::mag(), turbulenceModel::nuEff(), Foam::operator==(), Foam::foamVersion::patch, and turbulenceModel::propertiesName.

Here is the call graph for this function:

◆ write()

void write ( Ostream &  os) const
virtual

Write.

Definition at line 122 of file fixedShearStressFvPatchVectorField.C.

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

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