diff --git a/src/OpenFOAM/dimensionSet/dimensionSet.C b/src/OpenFOAM/dimensionSet/dimensionSet.C index 584889e3c1..4dddfb7a69 100644 --- a/src/OpenFOAM/dimensionSet/dimensionSet.C +++ b/src/OpenFOAM/dimensionSet/dimensionSet.C @@ -6,7 +6,7 @@ \\/ M anipulation | ------------------------------------------------------------------------------- Copyright (C) 2011-2017 OpenFOAM Foundation - Copyright (C) 2017-2021 OpenCFD Ltd. + Copyright (C) 2017-2022 OpenCFD Ltd. ------------------------------------------------------------------------------- License This file is part of OpenFOAM. @@ -518,6 +518,21 @@ Foam::dimensionSet Foam::hypot(const dimensionSet& ds1, const dimensionSet& ds2) } +Foam::dimensionSet Foam::stabilise +( + const dimensionSet& ds1, + const dimensionSet& ds2 +) +{ + if (dimensionSet::checking()) + { + checkDims("stabilise(a, b)", ds1, ds2); + } + + return ds1; +} + + Foam::dimensionSet Foam::transform(const dimensionSet& ds) { return ds; diff --git a/src/OpenFOAM/dimensionSet/dimensionSet.H b/src/OpenFOAM/dimensionSet/dimensionSet.H index 10d91eef57..d64d343668 100644 --- a/src/OpenFOAM/dimensionSet/dimensionSet.H +++ b/src/OpenFOAM/dimensionSet/dimensionSet.H @@ -6,7 +6,7 @@ \\/ M anipulation | ------------------------------------------------------------------------------- Copyright (C) 2011-2017 OpenFOAM Foundation - Copyright (C) 2017-2021 OpenCFD Ltd. + Copyright (C) 2017-2022 OpenCFD Ltd. ------------------------------------------------------------------------------- License This file is part of OpenFOAM. @@ -397,6 +397,9 @@ dimensionSet atan2(const dimensionSet& ds1, const dimensionSet& ds2); //- Arguments need the same dimensions. Does not change the dimension. dimensionSet hypot(const dimensionSet& ds1, const dimensionSet& ds2); +//- Arguments need the same dimensions. Does not change the dimension. +dimensionSet stabilise(const dimensionSet& ds1, const dimensionSet& ds2); + //- Return the argument; transformations do not change the dimensions dimensionSet transform(const dimensionSet& ds); diff --git a/src/OpenFOAM/dimensionedTypes/dimensionedScalar/dimensionedScalar.C b/src/OpenFOAM/dimensionedTypes/dimensionedScalar/dimensionedScalar.C index b592d6aea1..2dbe387c51 100644 --- a/src/OpenFOAM/dimensionedTypes/dimensionedScalar/dimensionedScalar.C +++ b/src/OpenFOAM/dimensionedTypes/dimensionedScalar/dimensionedScalar.C @@ -6,7 +6,7 @@ \\/ M anipulation | ------------------------------------------------------------------------------- Copyright (C) 2011-2017 OpenFOAM Foundation - Copyright (C) 2019 OpenCFD Ltd. + Copyright (C) 2019-2022 OpenCFD Ltd. ------------------------------------------------------------------------------- License This file is part of OpenFOAM. @@ -338,6 +338,21 @@ dimensionedScalar hypot } +dimensionedScalar stabilise +( + const dimensionedScalar& x, + const dimensionedScalar& y +) +{ + return dimensionedScalar + ( + "stabilise(" + x.name() + ',' + y.name() + ')', + stabilise(x.dimensions(), y.dimensions()), + stabilise(x.value(), y.value()) + ); +} + + // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // } // End namespace Foam diff --git a/src/OpenFOAM/dimensionedTypes/dimensionedScalar/dimensionedScalar.H b/src/OpenFOAM/dimensionedTypes/dimensionedScalar/dimensionedScalar.H index 94b7648796..820374df8e 100644 --- a/src/OpenFOAM/dimensionedTypes/dimensionedScalar/dimensionedScalar.H +++ b/src/OpenFOAM/dimensionedTypes/dimensionedScalar/dimensionedScalar.H @@ -6,7 +6,7 @@ \\/ M anipulation | ------------------------------------------------------------------------------- Copyright (C) 2011-2017 OpenFOAM Foundation - Copyright (C) 2019 OpenCFD Ltd. + Copyright (C) 2019-2022 OpenCFD Ltd. ------------------------------------------------------------------------------- License This file is part of OpenFOAM. @@ -102,6 +102,7 @@ dimensionedScalar jn(const int, const dimensionedScalar&); dimensionedScalar y0(const dimensionedScalar&); dimensionedScalar y1(const dimensionedScalar&); dimensionedScalar yn(const int, const dimensionedScalar&); +dimensionedScalar stabilise(const dimensionedScalar&, const dimensionedScalar&); // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // diff --git a/src/functionObjects/field/Make/files b/src/functionObjects/field/Make/files index c285367b66..59fabd85cd 100644 --- a/src/functionObjects/field/Make/files +++ b/src/functionObjects/field/Make/files @@ -84,6 +84,7 @@ Curle/Curle.C reference/reference.C log/log.C pow/pow.C +norm/norm.C fieldsExpression/fieldsExpression.C add/add.C diff --git a/src/functionObjects/field/norm/norm.C b/src/functionObjects/field/norm/norm.C new file mode 100644 index 0000000000..af0b208ce0 --- /dev/null +++ b/src/functionObjects/field/norm/norm.C @@ -0,0 +1,142 @@ +/*---------------------------------------------------------------------------*\ + ========= | + \\ / F ield | OpenFOAM: The Open Source CFD Toolbox + \\ / O peration | + \\ / A nd | www.openfoam.com + \\/ M anipulation | +------------------------------------------------------------------------------- + Copyright (C) 2022 OpenCFD Ltd. +------------------------------------------------------------------------------- +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 "norm.H" +#include "addToRunTimeSelectionTable.H" + +// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * // + +namespace Foam +{ +namespace functionObjects +{ + defineTypeNameAndDebug(norm, 0); + addToRunTimeSelectionTable(functionObject, norm, dictionary); +} +} + + +const Foam::Enum +< + Foam::functionObjects::norm::normType +> +Foam::functionObjects::norm::normTypeNames +({ + { normType::L1 , "L1" }, + { normType::L2 , "L2" }, + { normType::LP , "Lp" }, + { normType::MAX , "max" }, + { normType::COMPOSITE , "composite" }, + { normType::FIELD , "divisorField" } +}); + + +// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // + +// Implementation +#include "normImpl.C" + + +// * * * * * * * * * * * * * Private Member Functions * * * * * * * * * * * // + +bool Foam::functionObjects::norm::calc() +{ + return + ( + calcNorm() + || calcNorm() + || calcNorm() + || calcNorm() + || calcNorm() + ); +} + + +// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * // + +Foam::functionObjects::norm::norm +( + const word& name, + const Time& runTime, + const dictionary& dict +) +: + fieldExpression(name, runTime, dict), + norm_(normType::L1), + divisorPtr_(nullptr), + divisorFieldName_(word::null), + p_(-1) +{ + read(dict); +} + + +// * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * // + +bool Foam::functionObjects::norm::read(const dictionary& dict) +{ + if (!fieldExpression::read(dict)) + { + return false; + } + + norm_ = normTypeNames.get("norm", dict); + + if (norm_ == normType::LP) + { + p_ = dict.getCheck("p", scalarMinMax::ge(1)); + } + + if (norm_ == normType::COMPOSITE) + { + divisorPtr_ = Function1::New("divisor", dict, &mesh_); + + if (!divisorPtr_) + { + FatalIOErrorInFunction(dict) + << "The norm 'composite' needs the input entry 'divisor'." + << abort(FatalIOError); + } + } + + if (norm_ == normType::FIELD) + { + divisorFieldName_ = dict.get("divisorField"); + + if (divisorFieldName_ == word::null) + { + FatalIOErrorInFunction(dict) + << "The norm 'field' needs the input entry 'divisorField'." + << abort(FatalIOError); + } + } + + return true; +} + + +// ************************************************************************* // diff --git a/src/functionObjects/field/norm/norm.H b/src/functionObjects/field/norm/norm.H new file mode 100644 index 0000000000..540a24d332 --- /dev/null +++ b/src/functionObjects/field/norm/norm.H @@ -0,0 +1,285 @@ +/*---------------------------------------------------------------------------*\ + ========= | + \\ / F ield | OpenFOAM: The Open Source CFD Toolbox + \\ / O peration | + \\ / A nd | www.openfoam.com + \\/ M anipulation | +------------------------------------------------------------------------------- + Copyright (C) 2022 OpenCFD Ltd. +------------------------------------------------------------------------------- +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::norm + +Group + grpFieldFunctionObjects + +Description + Normalises an input field with a chosen norm, + and outputs a new normalised field. + + Operands: + \table + Operand | Type | Location + input | {vol,surface,polySurface}\Field | \/\/\ + output file | - | - + output field | {vol,surface,polySurface}\Field | \/\/\ + \endtable + + where \c \=Scalar/Vector/SphericalTensor/SymmTensor/Tensor. + +Usage + Minimal example by using \c system/controlDict.functions: + \verbatim + norm1 + { + // Mandatory entries + type norm; + libs (fieldFunctionObjects); + field ; + norm ; + + // Conditional entries + + // when norm == Lp + p ; + + // when norm == composite + divisor >; + + // when norm == divisorField + divisorField ; + + // Inherited entries + ... + } + \endverbatim + + where the entries mean: + \table + Property | Description | Type | Reqd | Deflt + type | Type name: norm | word | yes | - + libs | Library name: fieldFunctionObjects | word | yes | - + field | Name of the operand field | word | yes | - + norm | Name of normalisation operation | word | yes | - + p | Norm exponent for the p-norm | scalar | cndtnl | - + divisor | Norm divisor for the composite norm | Function1\ | cndtnl | - + divisorField | Divisor scalar field for the field norm | word | cndtnl | - + \endtable + + Options for the \c norm entry: + \verbatim + L1 | L1/Taxicab norm + L2 | L2/Euclidean norm + Lp | p norm + max | Maximum norm + composite | Composite norm comprising Function1 divisor + divisorField | Normalise by a given field + \endverbatim + + The inherited entries are elaborated in: + - \link functionObject.H \endlink + - \link fieldExpression.H \endlink + - \link Function1.H \endlink + + + The normalisations are held according to the following expressions: + + - \c L1: + + \f[ + \mathbf{y} = \frac{\mathbf{x}}{\Sigma_{i=1}^n |x_i|} + \f] + + - \c L2: + + \f[ + \mathbf{y} = \frac{\mathbf{x}}{\sqrt{x_1^2 + ... + x_n^2}} + \f] + + - \c Lp: + + \f[ + \mathbf{y} = \frac{\mathbf{x}}{(\Sigma_{i=1}^n |x_i|^p)^{1/p}} + \f] + + - \c max: + + \f[ + \mathbf{y} = \frac{\mathbf{x}}{max|x_i|} + \f] + + - \c composite: + + \f[ + \mathbf{y} = \frac{\mathbf{x}}{f(t)} + \f] + + - \c divisorField: + + \f[ + \mathbf{y} = \frac{\mathbf{x}}{\mathbf{z}} + \f] + +Note + - Divisor quantity is perturbed by \c SMALL value to prevent any divisions + by zero irrespective of whether the quantity is close to zero or not. + +SourceFiles + norm.C + normImpl.C + +\*---------------------------------------------------------------------------*/ + +#ifndef functionObjects_norm_H +#define functionObjects_norm_H + +#include "fieldExpression.H" +#include "Function1.H" +#include "polySurfaceFields.H" + +// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // + +namespace Foam +{ +namespace functionObjects +{ + +/*---------------------------------------------------------------------------*\ + Class norm Declaration +\*---------------------------------------------------------------------------*/ + +class norm +: + public fieldExpression +{ + // Private Enumerations + + //- Options for the norm algorithm + enum normType : char + { + L1, //!< "L1/Taxicab norm" + L2, //!< "L2/Euclidean norm" + LP, //!< "p norm" + MAX, //!< "Maximum norm" + COMPOSITE, //!< "Composite norm" + FIELD //!< "Normalise by a given field" + }; + + //- Names for normType + static const Enum normTypeNames; + + + // Private Data + + //- Norm algorithm + enum normType norm_; + + //- Norm divisor for the composite norm + autoPtr> divisorPtr_; + + //- Divisor scalar field for the field norm + word divisorFieldName_; + + //- Norm exponent for the p norm + scalar p_; + + + // Private Member Functions + + //- Calculate the chosen norm of the field and register the result + template + bool calcNorm(); + + //- Return the chosen norm of the field + template + tmp calcNormType(); + + //- Return the divisor volScalarField + template + tmp fieldNorm + ( + const GeometricField& + ); + + //- Return the divisor surfaceScalarField + template + tmp fieldNorm + ( + const GeometricField& + ); + + //- Return the divisor polySurfaceScalarField + template + tmp fieldNorm + ( + const DimensionedField& + ); + + //- Calculate the chosen norm of the field and return true if successful + virtual bool calc(); + + +public: + + //- Runtime type information + TypeName("norm"); + + + // Constructors + + //- Construct from name, Time and dictionary + norm + ( + const word& name, + const Time& runTime, + const dictionary& dict + ); + + //- No copy construct + norm(const norm&) = delete; + + //- No copy assignment + void operator=(const norm&) = delete; + + + //- Destructor + virtual ~norm() = default; + + + // Member Functions + + //- Read the dictionary data + virtual bool read(const dictionary&); +}; + + +// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // + +} // End namespace functionObjects +} // End namespace Foam + +// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // + +#endif + +// ************************************************************************* // diff --git a/src/functionObjects/field/norm/normImpl.C b/src/functionObjects/field/norm/normImpl.C new file mode 100644 index 0000000000..cdc60f618a --- /dev/null +++ b/src/functionObjects/field/norm/normImpl.C @@ -0,0 +1,160 @@ +/*---------------------------------------------------------------------------*\ + ========= | + \\ / F ield | OpenFOAM: The Open Source CFD Toolbox + \\ / O peration | + \\ / A nd | www.openfoam.com + \\/ M anipulation | +------------------------------------------------------------------------------- + Copyright (C) 2022 OpenCFD Ltd. +------------------------------------------------------------------------------- +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::norm::calcNorm() +{ + typedef GeometricField VolFieldType; + typedef GeometricField SurfaceFieldType; + typedef DimensionedField SurfFieldType; + + if (mesh_.foundObject(fieldName_)) + { + return store + ( + resultName_, + calcNormType() + ); + } + else if (mesh_.foundObject(fieldName_)) + { + return store + ( + resultName_, + calcNormType() + ); + } + else if (mesh_.foundObject(fieldName_)) + { + return store + ( + resultName_, + calcNormType() + ); + } + + return false; +} + + +template +Foam::tmp Foam::functionObjects::norm::calcNormType() +{ + const GeoFieldType& field = mesh_.lookupObject(fieldName_); + + const dimensionedScalar perturb(field.dimensions(), SMALL); + + switch (norm_) + { + case normType::L1: + { + return field/stabilise(sumMag(field), perturb); + } + + case normType::L2: + { + return field/stabilise(mag(field), perturb); + } + + case normType::LP: + { + return + field + /stabilise + ( + pow(pow(mag(field), p_), scalar(1)/p_), + perturb + ); + } + + case normType::MAX: + { + return field/stabilise(max(mag(field)), perturb); + } + + case normType::COMPOSITE: + { + const scalar t = mesh_.time().timeOutputValue(); + + const dimensionedScalar divisor + ( + field.dimensions(), + divisorPtr_->value(t) + ); + + return field/stabilise(divisor, perturb); + } + + case normType::FIELD: + { + return field/stabilise(fieldNorm(field), perturb); + } + + default: + break; + } + + return nullptr; +} + + +template +Foam::tmp Foam::functionObjects::norm::fieldNorm +( + const GeometricField& +) +{ + return mesh_.lookupObject(divisorFieldName_); +} + + +template +Foam::tmp Foam::functionObjects::norm::fieldNorm +( + const GeometricField& +) +{ + return mesh_.lookupObject(divisorFieldName_); +} + + +template +Foam::tmp Foam::functionObjects::norm::fieldNorm +( + const DimensionedField& +) +{ + return mesh_.lookupObject(divisorFieldName_); +} + + +// ************************************************************************* // diff --git a/tutorials/incompressible/pisoFoam/RAS/cavity/system/FOCourantNo b/tutorials/incompressible/pisoFoam/RAS/cavity/system/FOs/FOCourantNo similarity index 100% rename from tutorials/incompressible/pisoFoam/RAS/cavity/system/FOCourantNo rename to tutorials/incompressible/pisoFoam/RAS/cavity/system/FOs/FOCourantNo diff --git a/tutorials/incompressible/pisoFoam/RAS/cavity/system/FOLambVector b/tutorials/incompressible/pisoFoam/RAS/cavity/system/FOs/FOLambVector similarity index 100% rename from tutorials/incompressible/pisoFoam/RAS/cavity/system/FOLambVector rename to tutorials/incompressible/pisoFoam/RAS/cavity/system/FOs/FOLambVector diff --git a/tutorials/incompressible/pisoFoam/RAS/cavity/system/FOLambda2 b/tutorials/incompressible/pisoFoam/RAS/cavity/system/FOs/FOLambda2 similarity index 100% rename from tutorials/incompressible/pisoFoam/RAS/cavity/system/FOLambda2 rename to tutorials/incompressible/pisoFoam/RAS/cavity/system/FOs/FOLambda2 diff --git a/tutorials/incompressible/pisoFoam/RAS/cavity/system/FOPecletNo b/tutorials/incompressible/pisoFoam/RAS/cavity/system/FOs/FOPecletNo similarity index 100% rename from tutorials/incompressible/pisoFoam/RAS/cavity/system/FOPecletNo rename to tutorials/incompressible/pisoFoam/RAS/cavity/system/FOs/FOPecletNo diff --git a/tutorials/incompressible/pisoFoam/RAS/cavity/system/FOQ b/tutorials/incompressible/pisoFoam/RAS/cavity/system/FOs/FOQ similarity index 100% rename from tutorials/incompressible/pisoFoam/RAS/cavity/system/FOQ rename to tutorials/incompressible/pisoFoam/RAS/cavity/system/FOs/FOQ diff --git a/tutorials/incompressible/pisoFoam/RAS/cavity/system/FOadd b/tutorials/incompressible/pisoFoam/RAS/cavity/system/FOs/FOadd similarity index 100% rename from tutorials/incompressible/pisoFoam/RAS/cavity/system/FOadd rename to tutorials/incompressible/pisoFoam/RAS/cavity/system/FOs/FOadd diff --git a/tutorials/incompressible/pisoFoam/RAS/cavity/system/FOblendingFactor b/tutorials/incompressible/pisoFoam/RAS/cavity/system/FOs/FOblendingFactor similarity index 100% rename from tutorials/incompressible/pisoFoam/RAS/cavity/system/FOblendingFactor rename to tutorials/incompressible/pisoFoam/RAS/cavity/system/FOs/FOblendingFactor diff --git a/tutorials/incompressible/pisoFoam/RAS/cavity/system/FOcomponents b/tutorials/incompressible/pisoFoam/RAS/cavity/system/FOs/FOcomponents similarity index 100% rename from tutorials/incompressible/pisoFoam/RAS/cavity/system/FOcomponents rename to tutorials/incompressible/pisoFoam/RAS/cavity/system/FOs/FOcomponents diff --git a/tutorials/incompressible/pisoFoam/RAS/cavity/system/FOcontinuityError b/tutorials/incompressible/pisoFoam/RAS/cavity/system/FOs/FOcontinuityError similarity index 100% rename from tutorials/incompressible/pisoFoam/RAS/cavity/system/FOcontinuityError rename to tutorials/incompressible/pisoFoam/RAS/cavity/system/FOs/FOcontinuityError diff --git a/tutorials/incompressible/pisoFoam/RAS/cavity/system/FOddt b/tutorials/incompressible/pisoFoam/RAS/cavity/system/FOs/FOddt similarity index 100% rename from tutorials/incompressible/pisoFoam/RAS/cavity/system/FOddt rename to tutorials/incompressible/pisoFoam/RAS/cavity/system/FOs/FOddt diff --git a/tutorials/incompressible/pisoFoam/RAS/cavity/system/FOddt2 b/tutorials/incompressible/pisoFoam/RAS/cavity/system/FOs/FOddt2 similarity index 100% rename from tutorials/incompressible/pisoFoam/RAS/cavity/system/FOddt2 rename to tutorials/incompressible/pisoFoam/RAS/cavity/system/FOs/FOddt2 diff --git a/tutorials/incompressible/pisoFoam/RAS/cavity/system/FOdiv b/tutorials/incompressible/pisoFoam/RAS/cavity/system/FOs/FOdiv similarity index 100% rename from tutorials/incompressible/pisoFoam/RAS/cavity/system/FOdiv rename to tutorials/incompressible/pisoFoam/RAS/cavity/system/FOs/FOdiv diff --git a/tutorials/incompressible/pisoFoam/RAS/cavity/system/FOenstrophy b/tutorials/incompressible/pisoFoam/RAS/cavity/system/FOs/FOenstrophy similarity index 100% rename from tutorials/incompressible/pisoFoam/RAS/cavity/system/FOenstrophy rename to tutorials/incompressible/pisoFoam/RAS/cavity/system/FOs/FOenstrophy diff --git a/tutorials/incompressible/pisoFoam/RAS/cavity/system/FOfieldAverage b/tutorials/incompressible/pisoFoam/RAS/cavity/system/FOs/FOfieldAverage similarity index 100% rename from tutorials/incompressible/pisoFoam/RAS/cavity/system/FOfieldAverage rename to tutorials/incompressible/pisoFoam/RAS/cavity/system/FOs/FOfieldAverage diff --git a/tutorials/incompressible/pisoFoam/RAS/cavity/system/FOflowType b/tutorials/incompressible/pisoFoam/RAS/cavity/system/FOs/FOflowType similarity index 100% rename from tutorials/incompressible/pisoFoam/RAS/cavity/system/FOflowType rename to tutorials/incompressible/pisoFoam/RAS/cavity/system/FOs/FOflowType diff --git a/tutorials/incompressible/pisoFoam/RAS/cavity/system/FOflux b/tutorials/incompressible/pisoFoam/RAS/cavity/system/FOs/FOflux similarity index 100% rename from tutorials/incompressible/pisoFoam/RAS/cavity/system/FOflux rename to tutorials/incompressible/pisoFoam/RAS/cavity/system/FOs/FOflux diff --git a/tutorials/incompressible/pisoFoam/RAS/cavity/system/FOgrad b/tutorials/incompressible/pisoFoam/RAS/cavity/system/FOs/FOgrad similarity index 100% rename from tutorials/incompressible/pisoFoam/RAS/cavity/system/FOgrad rename to tutorials/incompressible/pisoFoam/RAS/cavity/system/FOs/FOgrad diff --git a/tutorials/incompressible/pisoFoam/RAS/cavity/system/FOhistogram b/tutorials/incompressible/pisoFoam/RAS/cavity/system/FOs/FOhistogram similarity index 100% rename from tutorials/incompressible/pisoFoam/RAS/cavity/system/FOhistogram rename to tutorials/incompressible/pisoFoam/RAS/cavity/system/FOs/FOhistogram diff --git a/tutorials/incompressible/pisoFoam/RAS/cavity/system/FOlimitFields b/tutorials/incompressible/pisoFoam/RAS/cavity/system/FOs/FOlimitFields similarity index 100% rename from tutorials/incompressible/pisoFoam/RAS/cavity/system/FOlimitFields rename to tutorials/incompressible/pisoFoam/RAS/cavity/system/FOs/FOlimitFields diff --git a/tutorials/incompressible/pisoFoam/RAS/cavity/system/FOlog b/tutorials/incompressible/pisoFoam/RAS/cavity/system/FOs/FOlog similarity index 100% rename from tutorials/incompressible/pisoFoam/RAS/cavity/system/FOlog rename to tutorials/incompressible/pisoFoam/RAS/cavity/system/FOs/FOlog diff --git a/tutorials/incompressible/pisoFoam/RAS/cavity/system/FOmag b/tutorials/incompressible/pisoFoam/RAS/cavity/system/FOs/FOmag similarity index 100% rename from tutorials/incompressible/pisoFoam/RAS/cavity/system/FOmag rename to tutorials/incompressible/pisoFoam/RAS/cavity/system/FOs/FOmag diff --git a/tutorials/incompressible/pisoFoam/RAS/cavity/system/FOmagSqr b/tutorials/incompressible/pisoFoam/RAS/cavity/system/FOs/FOmagSqr similarity index 100% rename from tutorials/incompressible/pisoFoam/RAS/cavity/system/FOmagSqr rename to tutorials/incompressible/pisoFoam/RAS/cavity/system/FOs/FOmagSqr diff --git a/tutorials/incompressible/pisoFoam/RAS/cavity/system/FOmomentum b/tutorials/incompressible/pisoFoam/RAS/cavity/system/FOs/FOmomentum similarity index 100% rename from tutorials/incompressible/pisoFoam/RAS/cavity/system/FOmomentum rename to tutorials/incompressible/pisoFoam/RAS/cavity/system/FOs/FOmomentum diff --git a/tutorials/incompressible/pisoFoam/RAS/cavity/system/FOmultiply b/tutorials/incompressible/pisoFoam/RAS/cavity/system/FOs/FOmultiply similarity index 100% rename from tutorials/incompressible/pisoFoam/RAS/cavity/system/FOmultiply rename to tutorials/incompressible/pisoFoam/RAS/cavity/system/FOs/FOmultiply diff --git a/tutorials/incompressible/pisoFoam/RAS/cavity/system/FOnearWallFields b/tutorials/incompressible/pisoFoam/RAS/cavity/system/FOs/FOnearWallFields similarity index 100% rename from tutorials/incompressible/pisoFoam/RAS/cavity/system/FOnearWallFields rename to tutorials/incompressible/pisoFoam/RAS/cavity/system/FOs/FOnearWallFields diff --git a/tutorials/incompressible/pisoFoam/RAS/cavity/system/FOs/FOnorm b/tutorials/incompressible/pisoFoam/RAS/cavity/system/FOs/FOnorm new file mode 100644 index 0000000000..d9faa90d6c --- /dev/null +++ b/tutorials/incompressible/pisoFoam/RAS/cavity/system/FOs/FOnorm @@ -0,0 +1,68 @@ +/*--------------------------------*- C++ -*----------------------------------*\ +| ========= | | +| \\ / F ield | OpenFOAM: The Open Source CFD Toolbox | +| \\ / O peration | Version: v2112 | +| \\ / A nd | Website: www.openfoam.com | +| \\/ M anipulation | | +\*---------------------------------------------------------------------------*/ + +norm_U_L1 +{ + // Mandatory entries + type norm; + libs (fieldFunctionObjects); + field U; + norm L1; + + // Inherited entries + result norm_U_L1; + region region0; + enabled true; + log true; + timeStart 0; + timeEnd 1000; + executeControl writeTime; + writeControl writeTime; +} + +norm_U_L2 +{ + $norm_U_L1; + norm L2; + result norm_U_L2; +} + +norm_U_Lp +{ + $norm_U_L1; + norm Lp; + p 3; + result norm_U_Lp; +} + +norm_U_max +{ + $norm_U_L1; + norm max; + result norm_U_max; +} + +norm_U_composite +{ + $norm_U_L1; + norm composite; + divisor constant 2; + result norm_U_composite; +} + +norm_k_field +{ + $norm_U_L1; + field k; + norm divisorField; + divisorField p; + result norm_k_field; +} + + +// ************************************************************************* // diff --git a/tutorials/incompressible/pisoFoam/RAS/cavity/system/FOpow b/tutorials/incompressible/pisoFoam/RAS/cavity/system/FOs/FOpow similarity index 100% rename from tutorials/incompressible/pisoFoam/RAS/cavity/system/FOpow rename to tutorials/incompressible/pisoFoam/RAS/cavity/system/FOs/FOpow diff --git a/tutorials/incompressible/pisoFoam/RAS/cavity/system/FOpressure b/tutorials/incompressible/pisoFoam/RAS/cavity/system/FOs/FOpressure similarity index 100% rename from tutorials/incompressible/pisoFoam/RAS/cavity/system/FOpressure rename to tutorials/incompressible/pisoFoam/RAS/cavity/system/FOs/FOpressure diff --git a/tutorials/incompressible/pisoFoam/RAS/cavity/system/FOprocessorField b/tutorials/incompressible/pisoFoam/RAS/cavity/system/FOs/FOprocessorField similarity index 100% rename from tutorials/incompressible/pisoFoam/RAS/cavity/system/FOprocessorField rename to tutorials/incompressible/pisoFoam/RAS/cavity/system/FOs/FOprocessorField diff --git a/tutorials/incompressible/pisoFoam/RAS/cavity/system/FOproudmanAcousticPower b/tutorials/incompressible/pisoFoam/RAS/cavity/system/FOs/FOproudmanAcousticPower similarity index 100% rename from tutorials/incompressible/pisoFoam/RAS/cavity/system/FOproudmanAcousticPower rename to tutorials/incompressible/pisoFoam/RAS/cavity/system/FOs/FOproudmanAcousticPower diff --git a/tutorials/incompressible/pisoFoam/RAS/cavity/system/FOrandomise b/tutorials/incompressible/pisoFoam/RAS/cavity/system/FOs/FOrandomise similarity index 100% rename from tutorials/incompressible/pisoFoam/RAS/cavity/system/FOrandomise rename to tutorials/incompressible/pisoFoam/RAS/cavity/system/FOs/FOrandomise diff --git a/tutorials/incompressible/pisoFoam/RAS/cavity/system/FOreadFields b/tutorials/incompressible/pisoFoam/RAS/cavity/system/FOs/FOreadFields similarity index 100% rename from tutorials/incompressible/pisoFoam/RAS/cavity/system/FOreadFields rename to tutorials/incompressible/pisoFoam/RAS/cavity/system/FOs/FOreadFields diff --git a/tutorials/incompressible/pisoFoam/RAS/cavity/system/FOreference b/tutorials/incompressible/pisoFoam/RAS/cavity/system/FOs/FOreference similarity index 100% rename from tutorials/incompressible/pisoFoam/RAS/cavity/system/FOreference rename to tutorials/incompressible/pisoFoam/RAS/cavity/system/FOs/FOreference diff --git a/tutorials/incompressible/pisoFoam/RAS/cavity/system/FOsetFlow b/tutorials/incompressible/pisoFoam/RAS/cavity/system/FOs/FOsetFlow similarity index 100% rename from tutorials/incompressible/pisoFoam/RAS/cavity/system/FOsetFlow rename to tutorials/incompressible/pisoFoam/RAS/cavity/system/FOs/FOsetFlow diff --git a/tutorials/incompressible/pisoFoam/RAS/cavity/system/FOsolverInfo b/tutorials/incompressible/pisoFoam/RAS/cavity/system/FOs/FOsolverInfo similarity index 100% rename from tutorials/incompressible/pisoFoam/RAS/cavity/system/FOsolverInfo rename to tutorials/incompressible/pisoFoam/RAS/cavity/system/FOs/FOsolverInfo diff --git a/tutorials/incompressible/pisoFoam/RAS/cavity/system/FOstreamFunction b/tutorials/incompressible/pisoFoam/RAS/cavity/system/FOs/FOstreamFunction similarity index 100% rename from tutorials/incompressible/pisoFoam/RAS/cavity/system/FOstreamFunction rename to tutorials/incompressible/pisoFoam/RAS/cavity/system/FOs/FOstreamFunction diff --git a/tutorials/incompressible/pisoFoam/RAS/cavity/system/FOstreamLine b/tutorials/incompressible/pisoFoam/RAS/cavity/system/FOs/FOstreamLine similarity index 100% rename from tutorials/incompressible/pisoFoam/RAS/cavity/system/FOstreamLine rename to tutorials/incompressible/pisoFoam/RAS/cavity/system/FOs/FOstreamLine diff --git a/tutorials/incompressible/pisoFoam/RAS/cavity/system/FOsubtract b/tutorials/incompressible/pisoFoam/RAS/cavity/system/FOs/FOsubtract similarity index 100% rename from tutorials/incompressible/pisoFoam/RAS/cavity/system/FOsubtract rename to tutorials/incompressible/pisoFoam/RAS/cavity/system/FOs/FOsubtract diff --git a/tutorials/incompressible/pisoFoam/RAS/cavity/system/FOsurfaceDistance b/tutorials/incompressible/pisoFoam/RAS/cavity/system/FOs/FOsurfaceDistance similarity index 100% rename from tutorials/incompressible/pisoFoam/RAS/cavity/system/FOsurfaceDistance rename to tutorials/incompressible/pisoFoam/RAS/cavity/system/FOs/FOsurfaceDistance diff --git a/tutorials/incompressible/pisoFoam/RAS/cavity/system/FOsurfaceInterpolate b/tutorials/incompressible/pisoFoam/RAS/cavity/system/FOs/FOsurfaceInterpolate similarity index 100% rename from tutorials/incompressible/pisoFoam/RAS/cavity/system/FOsurfaceInterpolate rename to tutorials/incompressible/pisoFoam/RAS/cavity/system/FOs/FOsurfaceInterpolate diff --git a/tutorials/incompressible/pisoFoam/RAS/cavity/system/FOturbulenceFields b/tutorials/incompressible/pisoFoam/RAS/cavity/system/FOs/FOturbulenceFields similarity index 100% rename from tutorials/incompressible/pisoFoam/RAS/cavity/system/FOturbulenceFields rename to tutorials/incompressible/pisoFoam/RAS/cavity/system/FOs/FOturbulenceFields diff --git a/tutorials/incompressible/pisoFoam/RAS/cavity/system/FOvalueAverage b/tutorials/incompressible/pisoFoam/RAS/cavity/system/FOs/FOvalueAverage similarity index 100% rename from tutorials/incompressible/pisoFoam/RAS/cavity/system/FOvalueAverage rename to tutorials/incompressible/pisoFoam/RAS/cavity/system/FOs/FOvalueAverage diff --git a/tutorials/incompressible/pisoFoam/RAS/cavity/system/FOvolFieldValue b/tutorials/incompressible/pisoFoam/RAS/cavity/system/FOs/FOvolFieldValue similarity index 100% rename from tutorials/incompressible/pisoFoam/RAS/cavity/system/FOvolFieldValue rename to tutorials/incompressible/pisoFoam/RAS/cavity/system/FOs/FOvolFieldValue diff --git a/tutorials/incompressible/pisoFoam/RAS/cavity/system/FOvorticity b/tutorials/incompressible/pisoFoam/RAS/cavity/system/FOs/FOvorticity similarity index 100% rename from tutorials/incompressible/pisoFoam/RAS/cavity/system/FOvorticity rename to tutorials/incompressible/pisoFoam/RAS/cavity/system/FOs/FOvorticity diff --git a/tutorials/incompressible/pisoFoam/RAS/cavity/system/FOwallShearStress b/tutorials/incompressible/pisoFoam/RAS/cavity/system/FOs/FOwallShearStress similarity index 100% rename from tutorials/incompressible/pisoFoam/RAS/cavity/system/FOwallShearStress rename to tutorials/incompressible/pisoFoam/RAS/cavity/system/FOs/FOwallShearStress diff --git a/tutorials/incompressible/pisoFoam/RAS/cavity/system/FOwriteCellCentres b/tutorials/incompressible/pisoFoam/RAS/cavity/system/FOs/FOwriteCellCentres similarity index 100% rename from tutorials/incompressible/pisoFoam/RAS/cavity/system/FOwriteCellCentres rename to tutorials/incompressible/pisoFoam/RAS/cavity/system/FOs/FOwriteCellCentres diff --git a/tutorials/incompressible/pisoFoam/RAS/cavity/system/FOwriteCellVolumes b/tutorials/incompressible/pisoFoam/RAS/cavity/system/FOs/FOwriteCellVolumes similarity index 100% rename from tutorials/incompressible/pisoFoam/RAS/cavity/system/FOwriteCellVolumes rename to tutorials/incompressible/pisoFoam/RAS/cavity/system/FOs/FOwriteCellVolumes diff --git a/tutorials/incompressible/pisoFoam/RAS/cavity/system/FOyPlus b/tutorials/incompressible/pisoFoam/RAS/cavity/system/FOs/FOyPlus similarity index 100% rename from tutorials/incompressible/pisoFoam/RAS/cavity/system/FOyPlus rename to tutorials/incompressible/pisoFoam/RAS/cavity/system/FOs/FOyPlus diff --git a/tutorials/incompressible/pisoFoam/RAS/cavity/system/FOzeroGradient b/tutorials/incompressible/pisoFoam/RAS/cavity/system/FOs/FOzeroGradient similarity index 100% rename from tutorials/incompressible/pisoFoam/RAS/cavity/system/FOzeroGradient rename to tutorials/incompressible/pisoFoam/RAS/cavity/system/FOs/FOzeroGradient diff --git a/tutorials/incompressible/pisoFoam/RAS/cavity/system/controlDict b/tutorials/incompressible/pisoFoam/RAS/cavity/system/controlDict index 03b72d8ef5..e340791b2c 100644 --- a/tutorials/incompressible/pisoFoam/RAS/cavity/system/controlDict +++ b/tutorials/incompressible/pisoFoam/RAS/cavity/system/controlDict @@ -48,57 +48,57 @@ runTimeModifiable true; functions { // field function objects - #include "FOfieldAverage" - #include "FOadd" - #include "FOblendingFactor" - #include "FOcomponents" - #include "FOCourantNo" - #include "FOcontinuityError" - #include "FOddt" - #include "FOddt2" - #include "FOdiv" - #include "FOenstrophy" - #include "FOflowType" - #include "FOflux" - #include "FOgrad" - #include "FOhistogram" - #include "FOLambda2" - #include "FOLambVector" - #include "FOlimitFields" - #include "FOlog" - #include "FOmag" - #include "FOmagSqr" - #include "FOmultiFieldValue" - #include "FOmultiply" - #include "FOmomentum" - #include "FOnearWallFields" - #include "FOPecletNo" - #include "FOpressure" - #include "FOprocessorField" - #include "FOproudmanAcousticPower" - #include "FOpow" - #include "FOQ" - #include "FOrandomise" - #include "FOreadFields" - #include "FOsetFlow" - #include "FOstreamFunction" - #include "FOstreamLine" - #include "FOsubtract" - //#include "FOsurfaceDistance" - #include "FOsurfaceInterpolate" - #include "FOturbulenceFields" - #include "FOvalueAverage" - #include "FOvolFieldValue" - #include "FOvorticity" - #include "FOreference" - #include "FOwallShearStress" - #include "FOwriteCellCentres" - #include "FOwriteCellVolumes" - #include "FOyPlus" - #include "FOzeroGradient" + #include "FOs/FOfieldAverage" + #include "FOs/FOadd" + #include "FOs/FOblendingFactor" + #include "FOs/FOcomponents" + #include "FOs/FOCourantNo" + #include "FOs/FOcontinuityError" + #include "FOs/FOddt" + #include "FOs/FOddt2" + #include "FOs/FOdiv" + #include "FOs/FOenstrophy" + #include "FOs/FOflowType" + #include "FOs/FOflux" + #include "FOs/FOgrad" + #include "FOs/FOhistogram" + #include "FOs/FOLambda2" + #include "FOs/FOLambVector" + #include "FOs/FOlimitFields" + #include "FOs/FOlog" + #include "FOs/FOmag" + #include "FOs/FOmagSqr" + #include "FOs/FOmultiply" + #include "FOs/FOmomentum" + #include "FOs/FOnearWallFields" + #include "FOs/FOPecletNo" + #include "FOs/FOpressure" + #include "FOs/FOprocessorField" + #include "FOs/FOproudmanAcousticPower" + #include "FOs/FOpow" + #include "FOs/FOQ" + #include "FOs/FOrandomise" + #include "FOs/FOreadFields" + #include "FOs/FOsetFlow" + #include "FOs/FOstreamFunction" + #include "FOs/FOstreamLine" + #include "FOs/FOsubtract" + //#include "FOs/FOsurfaceDistance" + #include "FOs/FOsurfaceInterpolate" + #include "FOs/FOturbulenceFields" + #include "FOs/FOvalueAverage" + #include "FOs/FOvolFieldValue" + #include "FOs/FOvorticity" + #include "FOs/FOreference" + #include "FOs/FOwallShearStress" + #include "FOs/FOwriteCellCentres" + #include "FOs/FOwriteCellVolumes" + #include "FOs/FOyPlus" + #include "FOs/FOzeroGradient" + #include "FOs/FOnorm" // utility function objects - #include "FOsolverInfo" + #include "FOs/FOsolverInfo" }