Skip to content
Snippets Groups Projects
Commit aa2bc174 authored by andy's avatar andy
Browse files

STYLE: Added description to oscillatingFixedValue BC header

parent c78781e1
No related merge requests found
......@@ -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
......
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment