fixedShearStressFvPatchVectorField Class Reference

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

#include <fixedShearStressFvPatchVectorField.H>

Inheritance diagram for fixedShearStressFvPatchVectorField:

Collaboration diagram for fixedShearStressFvPatchVectorField:

Public Member Functions
	TypeName ("fixedShearStress")
	Runtime type information.
	fixedShearStressFvPatchVectorField (const fvPatch &, const DimensionedField< vector, volMesh > &)
	Construct from patch and internal field.
	fixedShearStressFvPatchVectorField (const fvPatch &, const DimensionedField< vector, volMesh > &, const dictionary &)
	Construct from patch, internal field and dictionary.
	fixedShearStressFvPatchVectorField (const fixedShearStressFvPatchVectorField &, const fvPatch &, const DimensionedField< vector, volMesh > &, const fvPatchFieldMapper &)
	Construct by mapping given.
	fixedShearStressFvPatchVectorField (const fixedShearStressFvPatchVectorField &)
	Construct as copy.
	fixedShearStressFvPatchVectorField (const fixedShearStressFvPatchVectorField &, 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	updateCoeffs ()
	Update the coefficients associated with the patch field.
virtual void	write (Ostream &) const
	Write.

Detailed Description

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

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:

• fixedValueFvPatchFields.H

Source files

• fixedShearStressFvPatchVectorField.H
• fixedShearStressFvPatchVectorField.C

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 31 of file fixedShearStressFvPatchVectorField.C.

References p, and Foam::Zero.

Referenced by fixedShearStressFvPatchVectorField(), fixedShearStressFvPatchVectorField(), fixedShearStressFvPatchVectorField(), and TypeName().

Here is the caller graph for this function:

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 42 of file fixedShearStressFvPatchVectorField.C.

References dict, p, and Foam::Zero.

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 56 of file fixedShearStressFvPatchVectorField.C.

References fixedShearStressFvPatchVectorField(), and p.

Here is the call graph for this function:

fixedShearStressFvPatchVectorField() [4/5]

fixedShearStressFvPatchVectorField

(

const fixedShearStressFvPatchVectorField &

ptf

)

Construct as copy.

Definition at line 69 of file fixedShearStressFvPatchVectorField.C.

References fixedShearStressFvPatchVectorField().

Here is the call graph for this function:

fixedShearStressFvPatchVectorField() [5/5]

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

Construct as copy setting internal field reference.

Definition at line 79 of file fixedShearStressFvPatchVectorField.C.

References fixedShearStressFvPatchVectorField().

Here is the call graph for this function:

Member Function Documentation

TypeName()

TypeName

(

"fixedShearStress"

)

Runtime type information.

References fixedShearStressFvPatchVectorField().

Here is the call graph for this function:

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 178 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 IOobject::groupName(), Foam::mag(), turbulenceModel::nuEff(), Foam::operator==(), 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(), and fvPatchField< Type >::writeValueEntry().

Here is the call graph for this function:

---

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

• src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/fixedShearStress/fixedShearStressFvPatchVectorField.H
• src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/fixedShearStress/fixedShearStressFvPatchVectorField.C