functionObjects::randomise: New functionObject to create a field with a random perturbation

etc/caseDicts/postProcessing/fields/randomise

+/*--------------------------------*- C++ -*----------------------------------*\
+| =========                 |                                                 |
+| \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox           |
+|  \\    /   O peration     | Version:  dev                                   |
+|   \\  /    A nd           | Web:      www.OpenFOAM.org                      |
+|    \\/     M anipulation  |                                                 |
+\*---------------------------------------------------------------------------*/
+
+randomise
+{
+    // Set the magnitude of the perturbation
+    magPerturbation <scalar>;
+
+    #includeEtc "caseDicts/postProcessing/fields/randomise.cfg"
+}
+
+// ************************************************************************* //

etc/caseDicts/postProcessing/fields/randomise.cfg

+/*--------------------------------*- C++ -*----------------------------------*\
+| =========                 |                                                 |
+| \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox           |
+|  \\    /   O peration     | Version:  dev                                   |
+|   \\  /    A nd           | Web:      www.OpenFOAM.org                      |
+|    \\/     M anipulation  |                                                 |
+\*---------------------------------------------------------------------------*/
+
+type            randomise;
+libs            ("libfieldFunctionObjects.so");
+
+executeControl  writeTime;
+writeControl    writeTime;
+
+// ************************************************************************* //

src/postProcessing/functionObjects/field/randomise/randomise.C

+/*---------------------------------------------------------------------------*\
+  =========                 |
+  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
+   \\    /   O peration     |
+    \\  /    A nd           | Copyright (C) 2016 OpenFOAM Foundation
+     \\/     M anipulation  |
+-------------------------------------------------------------------------------
+License
+    This file is part of OpenFOAM.
+
+    OpenFOAM is free software: you can redistribute it and/or modify it
+    under the terms of the GNU General Public License as published by
+    the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
+
+    OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
+    ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+    FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
+    for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
+
+\*---------------------------------------------------------------------------*/
+
+#include "randomise.H"
+#include "addToRunTimeSelectionTable.H"
+
+// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
+
+namespace Foam
+{
+namespace functionObjects
+{
+    defineTypeNameAndDebug(randomise, 0);
+    addToRunTimeSelectionTable(functionObject, randomise, dictionary);
+}
+}
+
+
+// * * * * * * * * * * * * * Private Member Functions  * * * * * * * * * * * //
+
+bool Foam::functionObjects::randomise::calc()
+{
+    bool processed = false;
+
+    processed = processed || calcRandomised<scalar>();
+    processed = processed || calcRandomised<vector>();
+    processed = processed || calcRandomised<sphericalTensor>();
+    processed = processed || calcRandomised<symmTensor>();
+    processed = processed || calcRandomised<tensor>();
+
+    return processed;
+}
+
+
+// * * * * * * * * * * * * * * * * Constructors  * * * * * * * * * * * * * * //
+
+Foam::functionObjects::randomise::randomise
+(
+    const word& name,
+    const Time& runTime,
+    const dictionary& dict
+)
+:
+    fieldExpression(name, runTime, dict)
+{
+    read(dict);
+}
+
+
+// * * * * * * * * * * * * * * * * Destructor  * * * * * * * * * * * * * * * //
+
+Foam::functionObjects::randomise::~randomise()
+{}
+
+
+// * * * * * * * * * * * * * * * Member Functions  * * * * * * * * * * * * * //
+
+bool Foam::functionObjects::randomise::read(const dictionary& dict)
+{
+    fieldExpression::read(dict);
+
+    dict.lookup("magPerturbation") >> magPerturbation_;
+
+    return true;
+}
+
+
+// ************************************************************************* //

src/postProcessing/functionObjects/field/randomise/randomise.H

+/*---------------------------------------------------------------------------*\
+  =========                 |
+  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
+   \\    /   O peration     |
+    \\  /    A nd           | Copyright (C) 2016 OpenFOAM Foundation
+     \\/     M anipulation  |
+-------------------------------------------------------------------------------
+License
+    This file is part of OpenFOAM.
+
+    OpenFOAM is free software: you can redistribute it and/or modify it
+    under the terms of the GNU General Public License as published by
+    the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
+
+    OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
+    ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+    FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
+    for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
+
+Class
+    Foam::functionObjects::randomise
+
+Group
+    grpFieldFunctionObjects
+
+Description
+    This function object adds a random component to a field,
+    with a specified perturbation magnitude.
+
+    The operation can be applied to any volume field.
+
+SeeAlso
+    Foam::functionObjects::fvMeshFunctionObject
+
+SourceFiles
+    randomise.C
+
+\*---------------------------------------------------------------------------*/
+
+#ifndef functionObjects_randomise_H
+#define functionObjects_randomise_H
+
+#include "fieldExpression.H"
+
+// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
+namespace Foam
+{
+namespace functionObjects
+{
+
+/*---------------------------------------------------------------------------*\
+                           Class randomise Declaration
+\*---------------------------------------------------------------------------*/
+
+class randomise
+:
+    public fieldExpression
+{
+    // Private member data
+
+        //- The magnitude of the purturbation
+        scalar magPerturbation_;
+
+
+    // Private Member Functions
+
+        //- Calculate the randomisenitude of the field and register the result
+        template<class Type>
+        bool calcRandomised();
+
+        //- Calculate the randomised field and return true if successful
+        virtual bool calc();
+
+
+public:
+
+    //- Runtime type information
+    TypeName("randomise");
+
+
+    // Constructors
+
+        //- Construct from Time and dictionary
+        randomise
+        (
+            const word& name,
+            const Time& runTime,
+            const dictionary& dict
+        );
+
+
+    //- Destructor
+    virtual ~randomise();
+
+
+    // Member Functions
+
+        //- Read the randomise data
+        virtual bool read(const dictionary&);
+};
+
+
+// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
+} // End namespace functionObjects
+} // End namespace Foam
+
+// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
+#ifdef NoRepository
+    #include "randomiseTemplates.C"
+#endif
+
+// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
+#endif
+
+// ************************************************************************* //

src/postProcessing/functionObjects/field/randomise/randomiseTemplates.C

+/*---------------------------------------------------------------------------*\
+  =========                 |
+  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
+   \\    /   O peration     |
+    \\  /    A nd           | Copyright (C) 2016 OpenFOAM Foundation
+     \\/     M anipulation  |
+-------------------------------------------------------------------------------
+License
+    This file is part of OpenFOAM.
+
+    OpenFOAM is free software: you can redistribute it and/or modify it
+    under the terms of the GNU General Public License as published by
+    the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
+
+    OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
+    ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+    FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
+    for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
+
+\*---------------------------------------------------------------------------*/
+
+#include "volFields.H"
+#include "Random.H"
+
+// * * * * * * * * * * * * * * * Member Functions  * * * * * * * * * * * * * //
+
+template<class Type>
+bool Foam::functionObjects::randomise::calcRandomised()
+{
+    typedef GeometricField<Type, fvPatchField, volMesh> VolFieldType;
+
+    if (foundObject<VolFieldType>(fieldName_))
+    {
+        const VolFieldType& field = lookupObject<VolFieldType>(fieldName_);
+
+        resultName_ = fieldName_ + "Random";
+
+        tmp<VolFieldType> rfieldt(new VolFieldType(field));
+        VolFieldType& rfield = rfieldt.ref();
+
+        Random rand(1234567);
+
+        forAll(field, celli)
+        {
+            Type rndPert;
+            rand.randomise(rndPert);
+            rndPert = 2.0*rndPert - pTraits<Type>::one;
+            rndPert /= mag(rndPert);
+            rfield[celli] += magPerturbation_*rndPert;
+        }
+
+        return store(resultName_, rfieldt);
+    }
+    else
+    {
+        return false;
+    }
+}
+
+
+// ************************************************************************* //