From 04876abedb0944dc7138b8062413f05f73097510 Mon Sep 17 00:00:00 2001 From: Henry Weller Date: Sat, 18 Mar 2017 17:10:48 +0000 Subject: [PATCH] Function1: Added "Ramp" to the names of the ramp functions to avoid conflict with more general forms of those functions. --- src/OpenFOAM/Make/files | 10 +++--- .../halfCosineRamp.C} | 10 +++--- .../halfCosineRamp.H} | 20 ++++++------ .../linear.C => linearRamp/linearRamp.C} | 12 +++---- .../linear.H => linearRamp/linearRamp.H} | 24 +++++++------- .../quadraticRamp.C} | 10 +++--- .../quadraticRamp.H} | 24 +++++++------- .../quarterCosineRamp.C} | 13 +++++--- .../quarterCosineRamp.H} | 20 ++++++------ .../quarterSineRamp.C} | 10 +++--- .../quarterSineRamp.H} | 20 ++++++------ .../oscillatingBox/0.orig/U | 31 ++++++++++++------- 12 files changed, 108 insertions(+), 96 deletions(-) rename src/OpenFOAM/primitives/functions/Function1/{halfCosine/halfCosine.C => halfCosineRamp/halfCosineRamp.C} (87%) rename src/OpenFOAM/primitives/functions/Function1/{halfCosine/halfCosine.H => halfCosineRamp/halfCosineRamp.H} (88%) rename src/OpenFOAM/primitives/functions/Function1/{linear/linear.C => linearRamp/linearRamp.C} (86%) rename src/OpenFOAM/primitives/functions/Function1/{linear/linear.H => linearRamp/linearRamp.H} (84%) rename src/OpenFOAM/primitives/functions/Function1/{quadratic/quadratic.C => quadraticRamp/quadraticRamp.C} (87%) rename src/OpenFOAM/primitives/functions/Function1/{quadratic/quadratic.H => quadraticRamp/quadraticRamp.H} (85%) rename src/OpenFOAM/primitives/functions/Function1/{quarterCosine/quarterCosine.C => quarterCosineRamp/quarterCosineRamp.C} (86%) rename src/OpenFOAM/primitives/functions/Function1/{quarterCosine/quarterCosine.H => quarterCosineRamp/quarterCosineRamp.H} (87%) rename src/OpenFOAM/primitives/functions/Function1/{quarterSine/quarterSine.C => quarterSineRamp/quarterSineRamp.C} (87%) rename src/OpenFOAM/primitives/functions/Function1/{quarterSine/quarterSine.H => quarterSineRamp/quarterSineRamp.H} (87%) diff --git a/src/OpenFOAM/Make/files b/src/OpenFOAM/Make/files index 32cdbee9c..84f83567d 100644 --- a/src/OpenFOAM/Make/files +++ b/src/OpenFOAM/Make/files @@ -79,11 +79,11 @@ primitives/triad/triad.C /* Run-time selectable functions */ primitives/functions/Function1/makeDataEntries.C primitives/functions/Function1/ramp/ramp.C -primitives/functions/Function1/linear/linear.C -primitives/functions/Function1/quadratic/quadratic.C -primitives/functions/Function1/quarterSine/quarterSine.C -primitives/functions/Function1/quarterCosine/quarterCosine.C -primitives/functions/Function1/halfCosine/halfCosine.C +primitives/functions/Function1/linearRamp/linearRamp.C +primitives/functions/Function1/quadraticRamp/quadraticRamp.C +primitives/functions/Function1/quarterSineRamp/quarterSineRamp.C +primitives/functions/Function1/quarterCosineRamp/quarterCosineRamp.C +primitives/functions/Function1/halfCosineRamp/halfCosineRamp.C primitives/functions/Polynomial/polynomialFunction.C primitives/subModelBase/subModelBase.C diff --git a/src/OpenFOAM/primitives/functions/Function1/halfCosine/halfCosine.C b/src/OpenFOAM/primitives/functions/Function1/halfCosineRamp/halfCosineRamp.C similarity index 87% rename from src/OpenFOAM/primitives/functions/Function1/halfCosine/halfCosine.C rename to src/OpenFOAM/primitives/functions/Function1/halfCosineRamp/halfCosineRamp.C index 5abf42d10..7478be741 100644 --- a/src/OpenFOAM/primitives/functions/Function1/halfCosine/halfCosine.C +++ b/src/OpenFOAM/primitives/functions/Function1/halfCosineRamp/halfCosineRamp.C @@ -23,7 +23,7 @@ License \*---------------------------------------------------------------------------*/ -#include "halfCosine.H" +#include "halfCosineRamp.H" #include "mathematicalConstants.H" // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * // @@ -32,14 +32,14 @@ namespace Foam { namespace Function1Types { - makeScalarFunction1(halfCosine); + makeScalarFunction1(halfCosineRamp); } } // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * // -Foam::Function1Types::halfCosine::halfCosine +Foam::Function1Types::halfCosineRamp::halfCosineRamp ( const word& entryName, const dictionary& dict @@ -51,13 +51,13 @@ Foam::Function1Types::halfCosine::halfCosine // * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * // -Foam::Function1Types::halfCosine::~halfCosine() +Foam::Function1Types::halfCosineRamp::~halfCosineRamp() {} // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * // -Foam::scalar Foam::Function1Types::halfCosine::value(const scalar t) const +Foam::scalar Foam::Function1Types::halfCosineRamp::value(const scalar t) const { return 0.5*(1 - cos(constant::mathematical::pi*linearRamp(t))); } diff --git a/src/OpenFOAM/primitives/functions/Function1/halfCosine/halfCosine.H b/src/OpenFOAM/primitives/functions/Function1/halfCosineRamp/halfCosineRamp.H similarity index 88% rename from src/OpenFOAM/primitives/functions/Function1/halfCosine/halfCosine.H rename to src/OpenFOAM/primitives/functions/Function1/halfCosineRamp/halfCosineRamp.H index 774402adf..452fb4d54 100644 --- a/src/OpenFOAM/primitives/functions/Function1/halfCosine/halfCosine.H +++ b/src/OpenFOAM/primitives/functions/Function1/halfCosineRamp/halfCosineRamp.H @@ -22,7 +22,7 @@ License along with OpenFOAM. If not, see . Class - Foam::Function1Types::halfCosine + Foam::Function1Types::halfCosineRamp Description Half-cosine ramp function starting from 0 and increasing to 1 from \c start @@ -32,12 +32,12 @@ See also Foam::Function1Types::ramp SourceFiles - halfCosine.C + halfCosineRamp.C \*---------------------------------------------------------------------------*/ -#ifndef halfCosine_H -#define halfCosine_H +#ifndef halfCosineRamp_H +#define halfCosineRamp_H #include "ramp.H" @@ -49,29 +49,29 @@ namespace Function1Types { /*---------------------------------------------------------------------------*\ - Class halfCosine Declaration + Class halfCosineRamp Declaration \*---------------------------------------------------------------------------*/ -class halfCosine +class halfCosineRamp : public ramp { // Private Member Functions //- Disallow default bitwise assignment - void operator=(const halfCosine&); + void operator=(const halfCosineRamp&); public: // Runtime type information - TypeName("halfCosine"); + TypeName("halfCosineRamp"); // Constructors //- Construct from entry name and dictionary - halfCosine + halfCosineRamp ( const word& entryName, const dictionary& dict @@ -79,7 +79,7 @@ public: //- Destructor - virtual ~halfCosine(); + virtual ~halfCosineRamp(); // Member Functions diff --git a/src/OpenFOAM/primitives/functions/Function1/linear/linear.C b/src/OpenFOAM/primitives/functions/Function1/linearRamp/linearRamp.C similarity index 86% rename from src/OpenFOAM/primitives/functions/Function1/linear/linear.C rename to src/OpenFOAM/primitives/functions/Function1/linearRamp/linearRamp.C index 658a64bf3..039e526f6 100644 --- a/src/OpenFOAM/primitives/functions/Function1/linear/linear.C +++ b/src/OpenFOAM/primitives/functions/Function1/linearRamp/linearRamp.C @@ -23,7 +23,7 @@ License \*---------------------------------------------------------------------------*/ -#include "linear.H" +#include "linearRamp.H" // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * // @@ -31,14 +31,14 @@ namespace Foam { namespace Function1Types { - makeScalarFunction1(linear); + makeScalarFunction1(linearRamp); } } // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * // -Foam::Function1Types::linear::linear +Foam::Function1Types::linearRamp::linearRamp ( const word& entryName, const dictionary& dict @@ -50,15 +50,15 @@ Foam::Function1Types::linear::linear // * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * // -Foam::Function1Types::linear::~linear() +Foam::Function1Types::linearRamp::~linearRamp() {} // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * // -Foam::scalar Foam::Function1Types::linear::value(const scalar t) const +Foam::scalar Foam::Function1Types::linearRamp::value(const scalar t) const { - return linearRamp(t); + return ramp::linearRamp(t); } diff --git a/src/OpenFOAM/primitives/functions/Function1/linear/linear.H b/src/OpenFOAM/primitives/functions/Function1/linearRamp/linearRamp.H similarity index 84% rename from src/OpenFOAM/primitives/functions/Function1/linear/linear.H rename to src/OpenFOAM/primitives/functions/Function1/linearRamp/linearRamp.H index 4d4151934..ae956c099 100644 --- a/src/OpenFOAM/primitives/functions/Function1/linear/linear.H +++ b/src/OpenFOAM/primitives/functions/Function1/linearRamp/linearRamp.H @@ -22,22 +22,22 @@ License along with OpenFOAM. If not, see . Class - Foam::Function1Types::linear + Foam::Function1Types::linearRamp Description - Linear ramp function starting from 0 and increasing linearly to 1 from \c - start over the \c duration and remaining at 1 thereafter. + Linear ramp function starting from 0 and increasing linearRamply to 1 from + \c start over the \c duration and remaining at 1 thereafter. See also Foam::Function1Types::ramp SourceFiles - linear.C + linearRamp.C \*---------------------------------------------------------------------------*/ -#ifndef linear_H -#define linear_H +#ifndef linearRamp_H +#define linearRamp_H #include "ramp.H" @@ -49,29 +49,29 @@ namespace Function1Types { /*---------------------------------------------------------------------------*\ - Class linear Declaration + Class linearRamp Declaration \*---------------------------------------------------------------------------*/ -class linear +class linearRamp : public ramp { // Private Member Functions //- Disallow default bitwise assignment - void operator=(const linear&); + void operator=(const linearRamp&); public: // Runtime type information - TypeName("linear"); + TypeName("linearRamp"); // Constructors //- Construct from entry name and dictionary - linear + linearRamp ( const word& entryName, const dictionary& dict @@ -79,7 +79,7 @@ public: //- Destructor - virtual ~linear(); + virtual ~linearRamp(); // Member Functions diff --git a/src/OpenFOAM/primitives/functions/Function1/quadratic/quadratic.C b/src/OpenFOAM/primitives/functions/Function1/quadraticRamp/quadraticRamp.C similarity index 87% rename from src/OpenFOAM/primitives/functions/Function1/quadratic/quadratic.C rename to src/OpenFOAM/primitives/functions/Function1/quadraticRamp/quadraticRamp.C index a35f82e79..96945a771 100644 --- a/src/OpenFOAM/primitives/functions/Function1/quadratic/quadratic.C +++ b/src/OpenFOAM/primitives/functions/Function1/quadraticRamp/quadraticRamp.C @@ -23,7 +23,7 @@ License \*---------------------------------------------------------------------------*/ -#include "quadratic.H" +#include "quadraticRamp.H" // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * // @@ -31,14 +31,14 @@ namespace Foam { namespace Function1Types { - makeScalarFunction1(quadratic); + makeScalarFunction1(quadraticRamp); } } // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * // -Foam::Function1Types::quadratic::quadratic +Foam::Function1Types::quadraticRamp::quadraticRamp ( const word& entryName, const dictionary& dict @@ -50,13 +50,13 @@ Foam::Function1Types::quadratic::quadratic // * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * // -Foam::Function1Types::quadratic::~quadratic() +Foam::Function1Types::quadraticRamp::~quadraticRamp() {} // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * // -Foam::scalar Foam::Function1Types::quadratic::value(const scalar t) const +Foam::scalar Foam::Function1Types::quadraticRamp::value(const scalar t) const { return sqr(linearRamp(t)); } diff --git a/src/OpenFOAM/primitives/functions/Function1/quadratic/quadratic.H b/src/OpenFOAM/primitives/functions/Function1/quadraticRamp/quadraticRamp.H similarity index 85% rename from src/OpenFOAM/primitives/functions/Function1/quadratic/quadratic.H rename to src/OpenFOAM/primitives/functions/Function1/quadraticRamp/quadraticRamp.H index 39575bc5a..e05de5342 100644 --- a/src/OpenFOAM/primitives/functions/Function1/quadratic/quadratic.H +++ b/src/OpenFOAM/primitives/functions/Function1/quadraticRamp/quadraticRamp.H @@ -22,22 +22,22 @@ License along with OpenFOAM. If not, see . Class - Foam::Function1Types::quadratic + Foam::Function1Types::quadraticRamp Description - Quadratic ramp function starting from 0 and increasing quadratically to 1 - from \c t_0 over the \c duration and remaining at 1 thereafter. + Quadratic ramp function starting from 0 and increasing quadraticRampally + to 1 from \c t_0 over the \c duration and remaining at 1 thereafter. See also Foam::Function1Types::ramp SourceFiles - quadratic.C + quadraticRamp.C \*---------------------------------------------------------------------------*/ -#ifndef quadratic_H -#define quadratic_H +#ifndef quadraticRamp_H +#define quadraticRamp_H #include "ramp.H" @@ -49,29 +49,29 @@ namespace Function1Types { /*---------------------------------------------------------------------------*\ - Class quadratic Declaration + Class quadraticRamp Declaration \*---------------------------------------------------------------------------*/ -class quadratic +class quadraticRamp : public ramp { // Private Member Functions //- Disallow default bitwise assignment - void operator=(const quadratic&); + void operator=(const quadraticRamp&); public: // Runtime type information - TypeName("quadratic"); + TypeName("quadraticRamp"); // Constructors //- Construct from entry name and dictionary - quadratic + quadraticRamp ( const word& entryName, const dictionary& dict @@ -79,7 +79,7 @@ public: //- Destructor - virtual ~quadratic(); + virtual ~quadraticRamp(); // Member Functions diff --git a/src/OpenFOAM/primitives/functions/Function1/quarterCosine/quarterCosine.C b/src/OpenFOAM/primitives/functions/Function1/quarterCosineRamp/quarterCosineRamp.C similarity index 86% rename from src/OpenFOAM/primitives/functions/Function1/quarterCosine/quarterCosine.C rename to src/OpenFOAM/primitives/functions/Function1/quarterCosineRamp/quarterCosineRamp.C index 025df283f..21b438b74 100644 --- a/src/OpenFOAM/primitives/functions/Function1/quarterCosine/quarterCosine.C +++ b/src/OpenFOAM/primitives/functions/Function1/quarterCosineRamp/quarterCosineRamp.C @@ -23,7 +23,7 @@ License \*---------------------------------------------------------------------------*/ -#include "quarterCosine.H" +#include "quarterCosineRamp.H" #include "mathematicalConstants.H" // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * // @@ -32,14 +32,14 @@ namespace Foam { namespace Function1Types { - makeScalarFunction1(quarterCosine); + makeScalarFunction1(quarterCosineRamp); } } // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * // -Foam::Function1Types::quarterCosine::quarterCosine +Foam::Function1Types::quarterCosineRamp::quarterCosineRamp ( const word& entryName, const dictionary& dict @@ -51,13 +51,16 @@ Foam::Function1Types::quarterCosine::quarterCosine // * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * // -Foam::Function1Types::quarterCosine::~quarterCosine() +Foam::Function1Types::quarterCosineRamp::~quarterCosineRamp() {} // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * // -Foam::scalar Foam::Function1Types::quarterCosine::value(const scalar t) const +Foam::scalar Foam::Function1Types::quarterCosineRamp::value +( + const scalar t +) const { return 1 - cos(0.5*constant::mathematical::pi*linearRamp(t)); } diff --git a/src/OpenFOAM/primitives/functions/Function1/quarterCosine/quarterCosine.H b/src/OpenFOAM/primitives/functions/Function1/quarterCosineRamp/quarterCosineRamp.H similarity index 87% rename from src/OpenFOAM/primitives/functions/Function1/quarterCosine/quarterCosine.H rename to src/OpenFOAM/primitives/functions/Function1/quarterCosineRamp/quarterCosineRamp.H index a96db22bf..4fa845294 100644 --- a/src/OpenFOAM/primitives/functions/Function1/quarterCosine/quarterCosine.H +++ b/src/OpenFOAM/primitives/functions/Function1/quarterCosineRamp/quarterCosineRamp.H @@ -22,7 +22,7 @@ License along with OpenFOAM. If not, see . Class - Foam::Function1Types::quarterCosine + Foam::Function1Types::quarterCosineRamp Description Quarter-cosine ramp function starting from 0 and increasing to 1 from \c @@ -32,12 +32,12 @@ See also Foam::Function1Types::ramp SourceFiles - quarterCosine.C + quarterCosineRamp.C \*---------------------------------------------------------------------------*/ -#ifndef quarterCosine_H -#define quarterCosine_H +#ifndef quarterCosineRamp_H +#define quarterCosineRamp_H #include "ramp.H" @@ -49,29 +49,29 @@ namespace Function1Types { /*---------------------------------------------------------------------------*\ - Class quarterCosine Declaration + Class quarterCosineRamp Declaration \*---------------------------------------------------------------------------*/ -class quarterCosine +class quarterCosineRamp : public ramp { // Private Member Functions //- Disallow default bitwise assignment - void operator=(const quarterCosine&); + void operator=(const quarterCosineRamp&); public: // Runtime type information - TypeName("quarterCosine"); + TypeName("quarterCosineRamp"); // Constructors //- Construct from entry name and dictionary - quarterCosine + quarterCosineRamp ( const word& entryName, const dictionary& dict @@ -79,7 +79,7 @@ public: //- Destructor - virtual ~quarterCosine(); + virtual ~quarterCosineRamp(); // Member Functions diff --git a/src/OpenFOAM/primitives/functions/Function1/quarterSine/quarterSine.C b/src/OpenFOAM/primitives/functions/Function1/quarterSineRamp/quarterSineRamp.C similarity index 87% rename from src/OpenFOAM/primitives/functions/Function1/quarterSine/quarterSine.C rename to src/OpenFOAM/primitives/functions/Function1/quarterSineRamp/quarterSineRamp.C index ad144a405..d6b73876d 100644 --- a/src/OpenFOAM/primitives/functions/Function1/quarterSine/quarterSine.C +++ b/src/OpenFOAM/primitives/functions/Function1/quarterSineRamp/quarterSineRamp.C @@ -23,7 +23,7 @@ License \*---------------------------------------------------------------------------*/ -#include "quarterSine.H" +#include "quarterSineRamp.H" #include "mathematicalConstants.H" // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * // @@ -32,14 +32,14 @@ namespace Foam { namespace Function1Types { - makeScalarFunction1(quarterSine); + makeScalarFunction1(quarterSineRamp); } } // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * // -Foam::Function1Types::quarterSine::quarterSine +Foam::Function1Types::quarterSineRamp::quarterSineRamp ( const word& entryName, const dictionary& dict @@ -51,13 +51,13 @@ Foam::Function1Types::quarterSine::quarterSine // * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * // -Foam::Function1Types::quarterSine::~quarterSine() +Foam::Function1Types::quarterSineRamp::~quarterSineRamp() {} // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * // -Foam::scalar Foam::Function1Types::quarterSine::value(const scalar t) const +Foam::scalar Foam::Function1Types::quarterSineRamp::value(const scalar t) const { return sin(0.5*constant::mathematical::pi*linearRamp(t)); } diff --git a/src/OpenFOAM/primitives/functions/Function1/quarterSine/quarterSine.H b/src/OpenFOAM/primitives/functions/Function1/quarterSineRamp/quarterSineRamp.H similarity index 87% rename from src/OpenFOAM/primitives/functions/Function1/quarterSine/quarterSine.H rename to src/OpenFOAM/primitives/functions/Function1/quarterSineRamp/quarterSineRamp.H index 3e2d41368..95ef17d73 100644 --- a/src/OpenFOAM/primitives/functions/Function1/quarterSine/quarterSine.H +++ b/src/OpenFOAM/primitives/functions/Function1/quarterSineRamp/quarterSineRamp.H @@ -22,7 +22,7 @@ License along with OpenFOAM. If not, see . Class - Foam::Function1Types::quarterSine + Foam::Function1Types::quarterSineRamp Description Quarter-sine ramp function starting from 0 and increasing to 1 from \c start @@ -32,12 +32,12 @@ See also Foam::Function1Types::ramp SourceFiles - quarterSine.C + quarterSineRamp.C \*---------------------------------------------------------------------------*/ -#ifndef quarterSine_H -#define quarterSine_H +#ifndef quarterSineRamp_H +#define quarterSineRamp_H #include "ramp.H" @@ -49,29 +49,29 @@ namespace Function1Types { /*---------------------------------------------------------------------------*\ - Class quarterSine Declaration + Class quarterSineRamp Declaration \*---------------------------------------------------------------------------*/ -class quarterSine +class quarterSineRamp : public ramp { // Private Member Functions //- Disallow default bitwise assignment - void operator=(const quarterSine&); + void operator=(const quarterSineRamp&); public: // Runtime type information - TypeName("quarterSine"); + TypeName("quarterSineRamp"); // Constructors //- Construct from entry name and dictionary - quarterSine + quarterSineRamp ( const word& entryName, const dictionary& dict @@ -79,7 +79,7 @@ public: //- Destructor - virtual ~quarterSine(); + virtual ~quarterSineRamp(); // Member Functions diff --git a/tutorials/multiphase/potentialFreeSurfaceFoam/oscillatingBox/0.orig/U b/tutorials/multiphase/potentialFreeSurfaceFoam/oscillatingBox/0.orig/U index e66d1ae65..9994b7376 100644 --- a/tutorials/multiphase/potentialFreeSurfaceFoam/oscillatingBox/0.orig/U +++ b/tutorials/multiphase/potentialFreeSurfaceFoam/oscillatingBox/0.orig/U @@ -41,18 +41,27 @@ boundaryField normalVelocity { type uniformFixedValue; - uniformValue sine; - uniformValueCoeffs + + uniformValue { - frequency 1; - amplitude table - ( - ( 0 0) - ( 10 0.025) - (1000 0.025) - ); - scale (0 1 0); - level (0 0 0); + type scale; + + value + { + type sine; + + frequency 1; + amplitude 0.025; + scale (0 1 0); + level (0 0 0); + } + + scale + { + type linearRamp; + + duration 10; + } } }