diff --git a/src/finiteVolume/fields/fvPatchFields/derived/oscillatingFixedValue/oscillatingFixedValueFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/oscillatingFixedValue/oscillatingFixedValueFvPatchField.H index 9a3120a69dc03c1833433c2cc4dc510e742545c7..ba84bc1c262d7cfaac0885d448cb08e8650663ee 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/oscillatingFixedValue/oscillatingFixedValueFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/oscillatingFixedValue/oscillatingFixedValueFvPatchField.H @@ -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