zhyang-dev/OpenFOAM-12
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

scale: function object to multiply a field by a scale factor

Browse Source
This commit is contained in:
Chris Greenshields
2018-06-06 09:41:04 +01:00
parent c4d209345e
commit 7f49d6e2cc
5 changed files with 304 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
etc/caseDicts/postProcessing/fields/scale Normal file
View File

@ -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 <fieldName>;
result <outputFieldName>; // optional
scale 1;
executeControl writeTime;
writeControl writeTime;
// ************************************************************************* //

1
src/functionObjects/field/Make/files
View File

@ -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

96
src/functionObjects/field/scale/scale.C Normal file
View File

@ -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 <http://www.gnu.org/licenses/>.
\*---------------------------------------------------------------------------*/
#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<scalar>();
processed = processed || calcScale<vector>();
processed = processed || calcScale<sphericalTensor>();
processed = processed || calcScale<symmTensor>();
processed = processed || calcScale<tensor>();
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;
}
// ************************************************************************* //

123
src/functionObjects/field/scale/scale.H Normal file
View File

@ -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 <http://www.gnu.org/licenses/>.
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<class Type>
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
// ************************************************************************* //

60
src/functionObjects/field/scale/scaleTemplates.C Normal file
View File

@ -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 <http://www.gnu.org/licenses/>.
\*---------------------------------------------------------------------------*/
#include "volFields.H"
#include "surfaceFields.H"
// * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
template<class Type>
bool Foam::functionObjects::scale::calcScale()
{
typedef GeometricField<Type, fvPatchField, volMesh> VolFieldType;
typedef GeometricField<Type, fvsPatchField, surfaceMesh> SurfaceFieldType;
if (foundObject<VolFieldType>(fieldName_))
{
return store
(
resultName_,
scale_*lookupObject<VolFieldType>(fieldName_)
);
}
else if (foundObject<SurfaceFieldType>(fieldName_))
{
return store
(
resultName_,
scale_*lookupObject<SurfaceFieldType>(fieldName_)
);
}
else
{
return false;
}
}
// ************************************************************************* //