diff --git a/src/OpenFOAM/primitives/functions/Function1/Constant/Constant.H b/src/OpenFOAM/primitives/functions/Function1/Constant/Constant.H index 99674591c8..c37b9681b5 100644 --- a/src/OpenFOAM/primitives/functions/Function1/Constant/Constant.H +++ b/src/OpenFOAM/primitives/functions/Function1/Constant/Constant.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | Website: https://openfoam.org - \\ / A nd | Copyright (C) 2011-2020 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2022 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -27,7 +27,8 @@ Class Description Templated function that returns a constant value. - Usage - for entry \ returning the value : +Usage + For entry \ returning the value : \verbatim constant \endverbatim diff --git a/src/OpenFOAM/primitives/functions/Function1/One/OneConstant.H b/src/OpenFOAM/primitives/functions/Function1/One/OneConstant.H index d1c45d9626..11b138e826 100644 --- a/src/OpenFOAM/primitives/functions/Function1/One/OneConstant.H +++ b/src/OpenFOAM/primitives/functions/Function1/One/OneConstant.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | Website: https://openfoam.org - \\ / A nd | Copyright (C) 2017-2020 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2017-2022 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -27,7 +27,7 @@ Class Description Templated function that returns the corresponding 1 (one). - Usage: +Usage \verbatim one; \endverbatim diff --git a/src/OpenFOAM/primitives/functions/Function1/Ramp/Ramp.H b/src/OpenFOAM/primitives/functions/Function1/Ramp/Ramp.H index db645bbe6a..e176c5e2a3 100644 --- a/src/OpenFOAM/primitives/functions/Function1/Ramp/Ramp.H +++ b/src/OpenFOAM/primitives/functions/Function1/Ramp/Ramp.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | Website: https://openfoam.org - \\ / A nd | Copyright (C) 2017-2021 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2017-2022 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -29,7 +29,7 @@ Description increasing monotonically to 1 from \c start over the \c duration and remaining at 1 thereafter. - Usage: +Usage \verbatim ; Coeffs @@ -47,6 +47,24 @@ Description duration 20; } \endverbatim + or including a constant scaling factor: + \verbatim + + { + type scale; + + scale + { + type ; + + start 0; + duration 10; + } + + value 100; + } + \endverbatim + for more details of scaling the ramp see Foam::Function1s::Scale. Where: \table @@ -57,6 +75,7 @@ Description See also Foam::Function1 + Foam::Function1s::Scale SourceFiles Ramp.C diff --git a/src/OpenFOAM/primitives/functions/Function1/Scale/Scale.H b/src/OpenFOAM/primitives/functions/Function1/Scale/Scale.H index 86b97a35c8..a8accc8a57 100644 --- a/src/OpenFOAM/primitives/functions/Function1/Scale/Scale.H +++ b/src/OpenFOAM/primitives/functions/Function1/Scale/Scale.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | Website: https://openfoam.org - \\ / A nd | Copyright (C) 2017-2021 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2017-2022 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -32,7 +32,8 @@ Description This is particularly useful to ramp a time-varying value by one of the monotonic ramp functions. - Usage for a vector: +Usage + For a vector: \verbatim { @@ -78,7 +79,7 @@ Description } \endverbatim - Usage including the optional 'xScale' function: + Including the optional 'xScale' function: \verbatim { diff --git a/src/OpenFOAM/primitives/functions/Function1/Table/Table.H b/src/OpenFOAM/primitives/functions/Function1/Table/Table.H index d93df0be5c..e6816ee75b 100644 --- a/src/OpenFOAM/primitives/functions/Function1/Table/Table.H +++ b/src/OpenFOAM/primitives/functions/Function1/Table/Table.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | Website: https://openfoam.org - \\ / A nd | Copyright (C) 2011-2021 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2022 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -30,7 +30,7 @@ Description Items are stored in a list of Tuple2's. First column is always stored as scalar entries. Data is read in Tuple2 form: - Usage: +Usage \verbatim table ( @@ -74,7 +74,6 @@ Description The data may be read from a separate file in either native or CSV format: - Usage: \verbatim { diff --git a/src/OpenFOAM/primitives/functions/Function1/Table/TableReader/Csv/CsvTableReader.H b/src/OpenFOAM/primitives/functions/Function1/Table/TableReader/Csv/CsvTableReader.H index bb1eba8cfc..fd7db801ff 100644 --- a/src/OpenFOAM/primitives/functions/Function1/Table/TableReader/Csv/CsvTableReader.H +++ b/src/OpenFOAM/primitives/functions/Function1/Table/TableReader/Csv/CsvTableReader.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | Website: https://openfoam.org - \\ / A nd | Copyright (C) 2011-2020 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2022 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -31,7 +31,7 @@ Description components of the second (y) column are given by the componentColumns entry. - Usage: +Usage \verbatim nHeaderLine 4; // number of header lines refColumn 0; // reference column index diff --git a/src/OpenFOAM/primitives/functions/Function1/Table/TableReader/Embedded/EmbeddedTableReader.H b/src/OpenFOAM/primitives/functions/Function1/Table/TableReader/Embedded/EmbeddedTableReader.H index e5606bc6ae..d8682f218a 100644 --- a/src/OpenFOAM/primitives/functions/Function1/Table/TableReader/Embedded/EmbeddedTableReader.H +++ b/src/OpenFOAM/primitives/functions/Function1/Table/TableReader/Embedded/EmbeddedTableReader.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | Website: https://openfoam.org - \\ / A nd | Copyright (C) 2020 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2020-2022 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -30,7 +30,7 @@ Description This is a list of Tuple2's where the first (x) column is scalar, and the second (y) column is the type to be interpolated. - Usage: +Usage \verbatim values ( diff --git a/src/OpenFOAM/primitives/functions/Function1/Table/TableReader/Foam/FoamTableReader.H b/src/OpenFOAM/primitives/functions/Function1/Table/TableReader/Foam/FoamTableReader.H index dd334ef2bb..ff4abe2390 100644 --- a/src/OpenFOAM/primitives/functions/Function1/Table/TableReader/Foam/FoamTableReader.H +++ b/src/OpenFOAM/primitives/functions/Function1/Table/TableReader/Foam/FoamTableReader.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | Website: https://openfoam.org - \\ / A nd | Copyright (C) 2011-2020 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2022 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -29,7 +29,7 @@ Description of Tuple2's where the first (x) column is scalar, and the second (y) column is the type to be interpolated. - Usage: +Usage \verbatim ( (0.0 (1 2 3)) diff --git a/src/OpenFOAM/primitives/functions/Function1/Uniform/Uniform.H b/src/OpenFOAM/primitives/functions/Function1/Uniform/Uniform.H index 5a0ee8c9f2..5f6cb9989f 100644 --- a/src/OpenFOAM/primitives/functions/Function1/Uniform/Uniform.H +++ b/src/OpenFOAM/primitives/functions/Function1/Uniform/Uniform.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | Website: https://openfoam.org - \\ / A nd | Copyright (C) 2017-2020 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2017-2022 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -30,7 +30,8 @@ Description Provides backward-compatibility for cases where a field is spatially "uniform" and may be treated as a constant value. - Usage - for entry \ returning the value : +Usage + For entry \ returning the value : \verbatim uniform \endverbatim diff --git a/src/OpenFOAM/primitives/functions/Function1/Zero/ZeroConstant.H b/src/OpenFOAM/primitives/functions/Function1/Zero/ZeroConstant.H index c8516b1e0c..981d239284 100644 --- a/src/OpenFOAM/primitives/functions/Function1/Zero/ZeroConstant.H +++ b/src/OpenFOAM/primitives/functions/Function1/Zero/ZeroConstant.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | Website: https://openfoam.org - \\ / A nd | Copyright (C) 2017-2020 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2017-2022 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -27,7 +27,7 @@ Class Description Templated function that returns the corresponding 0 (zero). - Usage: +Usage \verbatim zero; \endverbatim diff --git a/src/OpenFOAM/primitives/functions/Function1/linearRamp/linearRamp.H b/src/OpenFOAM/primitives/functions/Function1/linearRamp/linearRamp.H index 2658f77ffa..6260f87ebe 100644 --- a/src/OpenFOAM/primitives/functions/Function1/linearRamp/linearRamp.H +++ b/src/OpenFOAM/primitives/functions/Function1/linearRamp/linearRamp.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | Website: https://openfoam.org - \\ / A nd | Copyright (C) 2017-2020 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2017-2022 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -28,8 +28,53 @@ Description Linear ramp function starting from 0 and increasing linearRamply to 1 from \c start over the \c duration and remaining at 1 thereafter. +Usage + \verbatim + linearRamp; + Coeffs + { + start 10; + duration 20; + } + \endverbatim + or + \verbatim + + { + type linearRamp; + start 10; + duration 20; + } + \endverbatim + or including a constant scaling factor: + \verbatim + + { + type scale; + + scale + { + type linearRamp; + + start 0; + duration 10; + } + + value 100; + } + \endverbatim + for more details of scaling the ramp see Foam::Function1s::Scale. + + Where: + \table + Property | Description | Required | Default value + start | Start time | no | 0 + duration | Duration | yes | + \endtable + See also Foam::Function1s::Ramp + Foam::Function1s::Scale SourceFiles linearRamp.C diff --git a/src/OpenFOAM/primitives/functions/Function1/reverseRamp/reverseRamp.H b/src/OpenFOAM/primitives/functions/Function1/reverseRamp/reverseRamp.H index ff7d318b2a..f343d02304 100644 --- a/src/OpenFOAM/primitives/functions/Function1/reverseRamp/reverseRamp.H +++ b/src/OpenFOAM/primitives/functions/Function1/reverseRamp/reverseRamp.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | Website: https://openfoam.org - \\ / A nd | Copyright (C) 2019-2020 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2019-2022 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -29,7 +29,8 @@ Description from 1 decreasing to 0 from \c start over the \c duration and remaining at 0 thereafter. - Usage for scaling a vector: +Usage + For scaling a vector: \verbatim { diff --git a/src/OpenFOAM/primitives/functions/Function1/squarePulse/squarePulse.H b/src/OpenFOAM/primitives/functions/Function1/squarePulse/squarePulse.H index bb61d02542..a98b140fdf 100644 --- a/src/OpenFOAM/primitives/functions/Function1/squarePulse/squarePulse.H +++ b/src/OpenFOAM/primitives/functions/Function1/squarePulse/squarePulse.H @@ -29,7 +29,7 @@ Description instantaneously to 1, remains at 1 for \c duration, then drops instantaneously back to 0. - Usage: +Usage \verbatim squarePulse; Coeffs diff --git a/src/OpenFOAM/primitives/functions/Function2/Constant/Constant2.H b/src/OpenFOAM/primitives/functions/Function2/Constant/Constant2.H index 00e6a326fb..e4e6b8faa3 100644 --- a/src/OpenFOAM/primitives/functions/Function2/Constant/Constant2.H +++ b/src/OpenFOAM/primitives/functions/Function2/Constant/Constant2.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | Website: https://openfoam.org - \\ / A nd | Copyright (C) 2020 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2020-2022 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -27,7 +27,8 @@ Class Description Templated function of two variables that returns a constant value. - Usage - for entry \ returning the value : +Usage + For entry \ returning the value : \verbatim constant ; \endverbatim diff --git a/src/OpenFOAM/primitives/functions/Function2/One/OneConstant2.H b/src/OpenFOAM/primitives/functions/Function2/One/OneConstant2.H index 177824dd38..8d89568804 100644 --- a/src/OpenFOAM/primitives/functions/Function2/One/OneConstant2.H +++ b/src/OpenFOAM/primitives/functions/Function2/One/OneConstant2.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | Website: https://openfoam.org - \\ / A nd | Copyright (C) 2020 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2020-2022 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -27,7 +27,7 @@ Class Description Templated function of two variables that returns the corresponding 1 (one). - Usage: +Usage \verbatim one; \endverbatim diff --git a/src/OpenFOAM/primitives/functions/Function2/Zero/ZeroConstant2.H b/src/OpenFOAM/primitives/functions/Function2/Zero/ZeroConstant2.H index 22a39ca5b9..c200d382c9 100644 --- a/src/OpenFOAM/primitives/functions/Function2/Zero/ZeroConstant2.H +++ b/src/OpenFOAM/primitives/functions/Function2/Zero/ZeroConstant2.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | Website: https://openfoam.org - \\ / A nd | Copyright (C) 2020 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2020-2022 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -27,7 +27,7 @@ Class Description Templated function of two variables that returns the corresponding 0 (zero). - Usage: +Usage \verbatim zero; \endverbatim