diff --git a/etc/caseDicts/postProcessing/fields/scale b/etc/caseDicts/postProcessing/fields/scale new file mode 100644 index 000000000..6ddad5ca5 --- /dev/null +++ b/etc/caseDicts/postProcessing/fields/scale @@ -0,0 +1,24 @@ +/*--------------------------------*- C++ -*----------------------------------*\ + ========= | + \\ / F ield | OpenFOAM: The Open Source CFD Toolbox + \\ / O peration | + \\ / A nd | Web: www.OpenFOAM.org + \\/ M anipulation | +------------------------------------------------------------------------------- +Description + Multiplies a field by a scale factor + +\*---------------------------------------------------------------------------*/ + +type scale; +libs ("libfieldFunctionObjects.so"); + +field ; +result ; // optional +scale 1; + +executeControl writeTime; +writeControl writeTime; + + +// ************************************************************************* // diff --git a/src/functionObjects/field/Make/files b/src/functionObjects/field/Make/files index d6c671666..081f8bc48 100644 --- a/src/functionObjects/field/Make/files +++ b/src/functionObjects/field/Make/files @@ -35,6 +35,7 @@ grad/grad.C ddt/ddt.C mag/mag.C magSqr/magSqr.C +scale/scale.C vorticity/vorticity.C enstrophy/enstrophy.C Q/Q.C diff --git a/src/functionObjects/field/scale/scale.C b/src/functionObjects/field/scale/scale.C new file mode 100644 index 000000000..c30b67304 --- /dev/null +++ b/src/functionObjects/field/scale/scale.C @@ -0,0 +1,96 @@ +/*---------------------------------------------------------------------------*\ + ========= | + \\ / F ield | OpenFOAM: The Open Source CFD Toolbox + \\ / O peration | + \\ / A nd | Copyright (C) 2018 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 . + +\*---------------------------------------------------------------------------*/ + +#include "scale.H" +#include "addToRunTimeSelectionTable.H" + +// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * // + +namespace Foam +{ +namespace functionObjects +{ + defineTypeNameAndDebug(scale, 0); + addToRunTimeSelectionTable(functionObject, scale, dictionary); +} +} + + +// * * * * * * * * * * * * * Private Member Functions * * * * * * * * * * * // + +bool Foam::functionObjects::scale::calc() +{ + bool processed = false; + + processed = processed || calcScale(); + processed = processed || calcScale(); + processed = processed || calcScale(); + processed = processed || calcScale(); + processed = processed || calcScale(); + + return processed; +} + + +// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * // + +Foam::functionObjects::scale::scale +( + const word& name, + const Time& runTime, + const dictionary& dict +) +: + fieldExpression(name, runTime, dict), + scale_(0) +{ + read(dict); +} + + +// * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * // + +Foam::functionObjects::scale::~scale() +{} + + +// * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * // + +bool Foam::functionObjects::scale::read(const dictionary& dict) +{ + fieldExpression::read(dict); + + if (resultName_.empty()) + { + resultName_ = "scale(" + fieldName_ + ")"; + } + + dict.lookup("scale") >> scale_; + + return true; +} + + +// ************************************************************************* // diff --git a/src/functionObjects/field/scale/scale.H b/src/functionObjects/field/scale/scale.H new file mode 100644 index 000000000..6f27ed7ae --- /dev/null +++ b/src/functionObjects/field/scale/scale.H @@ -0,0 +1,123 @@ +/*---------------------------------------------------------------------------*\ + ========= | + \\ / F ield | OpenFOAM: The Open Source CFD Toolbox + \\ / O peration | + \\ / A nd | Copyright (C) 2018 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 . + +Class + Foam::functionObjects::scale + +Group + grpFieldFunctionObjects + +Description + Multiplies a field by a scaling factor. + + The operation can be applied to any volume or surface fields generating a + volume or surface scalar field. + +See also + Foam::functionObjects::fvMeshFunctionObject + +SourceFiles + scale.C + +\*---------------------------------------------------------------------------*/ + +#ifndef functionObjects_scale_H +#define functionObjects_scale_H + +#include "fieldExpression.H" + +// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // + +namespace Foam +{ +namespace functionObjects +{ + +/*---------------------------------------------------------------------------*\ + Class scale Declaration +\*---------------------------------------------------------------------------*/ + +class scale +: + public fieldExpression +{ + // Private data + + //- Scale factor + scalar scale_; + + + // Private Member Functions + + //- Calculate the scale of the field and register the result + template + bool calcScale(); + + //- Calculate the scale of the field and return true if successful + virtual bool calc(); + + +public: + + //- Runtime type information + TypeName("scale"); + + + // Constructors + + //- Construct from Time and dictionary + scale + ( + const word& name, + const Time& runTime, + const dictionary& dict + ); + + + //- Destructor + virtual ~scale(); + + + // Member Functions + + //- Read the randomise data + virtual bool read(const dictionary&); +}; + + +// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // + +} // End namespace functionObjects +} // End namespace Foam + +// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // + +#ifdef NoRepository + #include "scaleTemplates.C" +#endif + +// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // + +#endif + +// ************************************************************************* // diff --git a/src/functionObjects/field/scale/scaleTemplates.C b/src/functionObjects/field/scale/scaleTemplates.C new file mode 100644 index 000000000..8915f81a9 --- /dev/null +++ b/src/functionObjects/field/scale/scaleTemplates.C @@ -0,0 +1,60 @@ +/*---------------------------------------------------------------------------*\ + ========= | + \\ / F ield | OpenFOAM: The Open Source CFD Toolbox + \\ / O peration | + \\ / A nd | Copyright (C) 2018 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 . + +\*---------------------------------------------------------------------------*/ + +#include "volFields.H" +#include "surfaceFields.H" + +// * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * // + +template +bool Foam::functionObjects::scale::calcScale() +{ + typedef GeometricField VolFieldType; + typedef GeometricField SurfaceFieldType; + + if (foundObject(fieldName_)) + { + return store + ( + resultName_, + scale_*lookupObject(fieldName_) + ); + } + else if (foundObject(fieldName_)) + { + return store + ( + resultName_, + scale_*lookupObject(fieldName_) + ); + } + else + { + return false; + } +} + + +// ************************************************************************* //