songtianlun/openfoam
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

STYLE: Added description to oscillatingFixedValue BC header

Browse Source
This commit is contained in:
andy 2011-12-08 12:03:32 +00:00
parent c78781e19b
commit aa2bc1745a
1 changed files with 18 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
src/finiteVolume/fields/fvPatchFields/derived/oscillatingFixedValue/oscillatingFixedValueFvPatchField.H
View File

@ -25,7 +25,24 @@ Class
Foam::oscillatingFixedValueFvPatchField
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
oscillatingFixedValueFvPatchField.C