From fa32677e7af0235dcb7d1fff9fcd12f36171c7c9 Mon Sep 17 00:00:00 2001 From: sergio Date: Tue, 20 Dec 2016 12:26:47 -0800 Subject: [PATCH] ENh: Adding flux FO --- src/functionObjects/field/flux/flux.C | 92 ++++++++++++++ src/functionObjects/field/flux/flux.H | 117 ++++++++++++++++++ .../field/flux/fluxTemplates.C | 70 +++++++++++ 3 files changed, 279 insertions(+) create mode 100644 src/functionObjects/field/flux/flux.C create mode 100644 src/functionObjects/field/flux/flux.H create mode 100644 src/functionObjects/field/flux/fluxTemplates.C diff --git a/src/functionObjects/field/flux/flux.C b/src/functionObjects/field/flux/flux.C new file mode 100644 index 0000000000..f4545033e5 --- /dev/null +++ b/src/functionObjects/field/flux/flux.C @@ -0,0 +1,92 @@ +/*---------------------------------------------------------------------------*\ + ========= | + \\ / F ield | OpenFOAM: The Open Source CFD Toolbox + \\ / O peration | + \\ / A nd | Copyright (C) 2016 OpenCFD Ltd. + \\/ 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 "flux.H" +#include "volFields.H" +#include "surfaceFields.H" +#include "addToRunTimeSelectionTable.H" +#include "geometricOneField.H" + +// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * // + +namespace Foam +{ +namespace functionObjects +{ + defineTypeNameAndDebug(flux, 0); + addToRunTimeSelectionTable(functionObject, flux, dictionary); +} +} + + +// * * * * * * * * * * * * * Private Member Functions * * * * * * * * * * * // + +bool Foam::functionObjects::flux::calc() +{ + bool processed = false; + + if (rhoName_ == "none") + { + processed = + processed + || calcSurFlux(geometricOneField()); + + processed = + processed + || calcVolFlux(geometricOneField()); + } + else + { + const volScalarField& rho = + mesh_.lookupObject(rhoName_); + processed = processed || calcSurFlux(rho); + processed = processed || calcVolFlux(rho); + } + + return processed; +} + + +// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * // + +Foam::functionObjects::flux::flux +( + const word& name, + const Time& runTime, + const dictionary& dict +) +: + fieldExpression(name, runTime, dict), + rhoName_(dict.lookupOrDefault("rho", "none")) +{} + + +// * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * // + +Foam::functionObjects::flux::~flux() +{} + + +// ************************************************************************* // diff --git a/src/functionObjects/field/flux/flux.H b/src/functionObjects/field/flux/flux.H new file mode 100644 index 0000000000..8569abd0dc --- /dev/null +++ b/src/functionObjects/field/flux/flux.H @@ -0,0 +1,117 @@ +/*---------------------------------------------------------------------------*\ + ========= | + \\ / F ield | OpenFOAM: The Open Source CFD Toolbox + \\ / O peration | + \\ / A nd | Copyright (C) 2016 OpenCFD Ltd. + \\/ 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::flux + +Group + grpFieldFunctionObjects + +Description + Calculates the flux of a field. The operation is limited to + surfaceVectorFields and volVectorFields, and the output is a surfaceScalarField. + +See also + Foam::functionObjects::fieldExpression + Foam::functionObjects::fvMeshFunctionObject + +SourceFiles + flux.C + +\*---------------------------------------------------------------------------*/ + +#ifndef functionObjects_flux_H +#define functionObjects_flux_H + +#include "fieldExpression.H" + +// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // + +namespace Foam +{ +namespace functionObjects +{ + +/*---------------------------------------------------------------------------*\ + Class flux Declaration +\*---------------------------------------------------------------------------*/ + +class flux +: + public fieldExpression +{ + // Private Member Functions + + //- Calculate the flux of a volVectorField and register the result + template + bool calcVolFlux(const RhoFieldType& rho); + + //- Calculate the flux of a surfaceVectorField and register the result + template + bool calcSurFlux(const RhoFieldType& rho); + + //- Calculate the flux field and return true if successful + virtual bool calc(); + + //- rho flied name + word rhoName_; + + +public: + + //- Runtime type information + TypeName("flux"); + + + // Constructors + + //- Construct from Time and dictionary + flux + ( + const word& name, + const Time& runTime, + const dictionary& dict + ); + + + //- Destructor + virtual ~flux(); +}; + + +// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // + +} // End namespace functionObjects +} // End namespace Foam + +// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // + +#ifdef NoRepository + #include "fluxTemplates.C" +#endif + +// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // + +#endif + +// ************************************************************************* // diff --git a/src/functionObjects/field/flux/fluxTemplates.C b/src/functionObjects/field/flux/fluxTemplates.C new file mode 100644 index 0000000000..e29b6d85ed --- /dev/null +++ b/src/functionObjects/field/flux/fluxTemplates.C @@ -0,0 +1,70 @@ +/*---------------------------------------------------------------------------*\ + ========= | + \\ / F ield | OpenFOAM: The Open Source CFD Toolbox + \\ / O peration | + \\ / A nd | Copyright (C) 2016 OpenCFD Ltd. + \\/ 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 "fvcFlux.H" +#include "surfaceInterpolate.H" + +// * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * // + +template +bool Foam::functionObjects::flux::calcVolFlux(const RhoFieldType& rho) +{ + + if (foundObject(fieldName_, false)) + { + return store + ( + resultName_, + fvc::flux(rho*lookupObject(fieldName_)) + ); + } + else + { + return false; + } +} + + +template +bool Foam::functionObjects::flux::calcSurFlux(const RhoFieldType& rho) +{ + + if (foundObject(fieldName_, false)) + { + return store + ( + resultName_, + ( + fvc::interpolate(rho) + *lookupObject(fieldName_) + ) & mesh_.Sf() + ); + } + else + { + return false; + } +} +// ************************************************************************* //