mirror of
https://develop.openfoam.com/Development/openfoam.git
synced 2025-11-28 03:28:01 +00:00
STYLE: Added description to oscillatingFixedValue BC header
This commit is contained in:
@ -25,7 +25,24 @@ Class
|
|||||||
Foam::oscillatingFixedValueFvPatchField
|
Foam::oscillatingFixedValueFvPatchField
|
||||||
|
|
||||||
Description
|
Description
|
||||||
Foam::oscillatingFixedValueFvPatchField
|
Describes an oscillating boundary condition in terms of amplitude and
|
||||||
|
frequency.
|
||||||
|
|
||||||
|
Example of the boundary condition specification:
|
||||||
|
\verbatim
|
||||||
|
inlet
|
||||||
|
{
|
||||||
|
type oscillatingFixedValue;
|
||||||
|
refValue uniform 5.0;
|
||||||
|
offset 0.0; // optional
|
||||||
|
amplitude constant 0.5;
|
||||||
|
frequency constant 10;
|
||||||
|
}
|
||||||
|
\endverbatim
|
||||||
|
|
||||||
|
The amplitude and frequency entries are DataEntry types, able to describe
|
||||||
|
time varying functions. The example above gives the usage for supplying
|
||||||
|
constant values.
|
||||||
|
|
||||||
SourceFiles
|
SourceFiles
|
||||||
oscillatingFixedValueFvPatchField.C
|
oscillatingFixedValueFvPatchField.C
|
||||||
|
|||||||
Reference in New Issue
Block a user