diff --git a/src/postProcessing/functionObjects/residualControl/IOresidualControl.H b/src/postProcessing/functionObjects/residualControl/IOresidualControl.H new file mode 100644 index 0000000000..8a2b3bfed1 --- /dev/null +++ b/src/postProcessing/functionObjects/residualControl/IOresidualControl.H @@ -0,0 +1,49 @@ +/*---------------------------------------------------------------------------*\ + ========= | + \\ / F ield | OpenFOAM: The Open Source CFD Toolbox + \\ / O peration | + \\ / A nd | Copyright (C) 2010-2010 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 . + +Typedef + Foam::IOresidualControl + +Description + Instance of the generic IOOutputFilter for residualControl. + +\*---------------------------------------------------------------------------*/ + +#ifndef IOresidualControl_H +#define IOresidualControl_H + +#include "residualControl.H" +#include "IOOutputFilter.H" + +// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // + +namespace Foam +{ + typedef IOOutputFilter IOresidualControl; +} + +// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // + +#endif + +// ************************************************************************* // diff --git a/src/postProcessing/functionObjects/residualControl/Make/files b/src/postProcessing/functionObjects/residualControl/Make/files new file mode 100644 index 0000000000..c3bc44fe41 --- /dev/null +++ b/src/postProcessing/functionObjects/residualControl/Make/files @@ -0,0 +1,4 @@ +residualControl.C +residualControlFunctionObject.C + +LIB = $(FOAM_LIBBIN)/libresidualControl diff --git a/src/postProcessing/functionObjects/residualControl/Make/options b/src/postProcessing/functionObjects/residualControl/Make/options new file mode 100644 index 0000000000..5166bcc9e3 --- /dev/null +++ b/src/postProcessing/functionObjects/residualControl/Make/options @@ -0,0 +1,9 @@ +EXE_INC = \ + -I$(LIB_SRC)/finiteVolume/lnInclude \ + -I$(LIB_SRC)/meshTools/lnInclude \ + -I$(LIB_SRC)/sampling/lnInclude + +LIB_LIBS = \ + -lfiniteVolume \ + -lmeshTools \ + -lsampling diff --git a/src/postProcessing/functionObjects/residualControl/controlDict b/src/postProcessing/functionObjects/residualControl/controlDict new file mode 100644 index 0000000000..0af8ff7c9a --- /dev/null +++ b/src/postProcessing/functionObjects/residualControl/controlDict @@ -0,0 +1,67 @@ +*--------------------------------*- C++ -*----------------------------------*\ +| ========= | | +| \\ / F ield | OpenFOAM: The Open Source CFD Toolbox | +| \\ / O peration | Version: 1.6 | +| \\ / A nd | Web: www.OpenFOAM.org | +| \\/ M anipulation | | +\*---------------------------------------------------------------------------*/ +FoamFile +{ + version 2.0; + format ascii; + class dictionary; + location "system"; + object controlDict; +} +// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // + +application icoFoam; + +startFrom startTime; + +startTime 0; + +stopAt endTime; + +endTime 0.5; + +deltaT 0.005; + +writeControl timeStep; + +writeInterval 20; + +purgeWrite 0; + +writeFormat ascii; + +writePrecision 6; + +writeCompression uncompressed; + +timeFormat general; + +timePrecision 6; + +runTimeModifiable yes; + + +functions +( + convergenceChecks + { + type residualControl; + functionObjectLibs ( "libresidualControl.so" ); + outputControl timeStep; + outputInterval 1; + + maxResiduals + ( + (p 5e-4) + (U 1e-3) + ); + } +); + + +// ************************************************************************* // diff --git a/src/postProcessing/functionObjects/residualControl/residualControl.C b/src/postProcessing/functionObjects/residualControl/residualControl.C new file mode 100644 index 0000000000..aed8e38dc1 --- /dev/null +++ b/src/postProcessing/functionObjects/residualControl/residualControl.C @@ -0,0 +1,174 @@ +/*---------------------------------------------------------------------------*\ + ========= | + \\ / F ield | OpenFOAM: The Open Source CFD Toolbox + \\ / O peration | + \\ / A nd | Copyright (C) 2010-2010 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 "residualControl.H" +#include "dictionary.H" +#include "fvMesh.H" +#include "Time.H" + +// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * // + +namespace Foam +{ + defineTypeNameAndDebug(residualControl, 0); +} + + +// * * * * * * * * * * * * Protected Member Functions * * * * * * * * * * * // + +bool Foam::residualControl::checkCriteria(const bool output) const +{ + bool achieved = true; + const fvMesh& mesh = static_cast(obr_); + const dictionary& solverDict = mesh.solverPerformanceDict(); + forAll(maxResiduals_, i) + { + const word& variableName = maxResiduals_[i].first(); + if (solverDict.found(variableName)) + { + const scalar maxResidual = maxResiduals_[i].second(); + + const lduMatrix::solverPerformance + sp(solverDict.lookup(variableName)); + + const scalar eqnResidual = sp.initialResidual(); + + achieved = achieved && (eqnResidual < maxResidual); + + if (output) + { + Info<< " " << variableName + << ": requested max residual = " << maxResidual + << ", eqn residual = " << eqnResidual << nl; + } + } + } + + return achieved; +} + + +// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * // + +Foam::residualControl::residualControl +( + const word& name, + const objectRegistry& obr, + const dictionary& dict, + const bool +) +: + name_(name), + obr_(obr), + active_(true), + maxResiduals_(), + criteriaSatisfied_(false) +{ + // Only active if a fvMesh is available + if (isA(obr_)) + { + read(dict); + } + else + { + active_ = false; + WarningIn + ( + "residualControl::residualControl" + "(" + "const word&, " + "const objectRegistry&, " + "const dictionary&, " + "const bool" + ")" + ) << "No fvMesh available, deactivating." + << nl << endl; + } +} + + +// * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * // + +Foam::residualControl::~residualControl() +{} + + +// * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * // + +void Foam::residualControl::read(const dictionary& dict) +{ + if (active_) + { + dict.lookup("maxResiduals") >> maxResiduals_; + } +} + + +void Foam::residualControl::execute() +{ + if (active_) + { + criteriaSatisfied_ = checkCriteria(false); + + if (criteriaSatisfied_) + { + Info<< "Convergence criteria satisfied - finalising run" << nl + << endl; + + checkCriteria(true); + + Info<< endl; + + const fvMesh& mesh = static_cast(obr_); + Time& time = const_cast(mesh.time()); + time.writeAndEnd(); + } + } +} + + +void Foam::residualControl::end() +{ + if (active_) + { + if (criteriaSatisfied_) + { + Info<< "Residual control criteria satisfied" << nl; + } + else + { + Info<< "Residual control criteria not satisfied" << nl; + } + } +} + + +void Foam::residualControl::write() +{ + // do nothing +} + + +// ************************************************************************* // diff --git a/src/postProcessing/functionObjects/residualControl/residualControl.H b/src/postProcessing/functionObjects/residualControl/residualControl.H new file mode 100644 index 0000000000..c222019298 --- /dev/null +++ b/src/postProcessing/functionObjects/residualControl/residualControl.H @@ -0,0 +1,152 @@ +/*---------------------------------------------------------------------------*\ + ========= | + \\ / F ield | OpenFOAM: The Open Source CFD Toolbox + \\ / O peration | + \\ / A nd | Copyright (C) 2010-2010 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::residualControl + +Description + Function object that allows users to set target convergence criteria, and + stop the run if the conditions are satisfied. + +SourceFiles + residualControl.C + IOresidualControl.H + +\*---------------------------------------------------------------------------*/ + +#ifndef residualControl_H +#define residualControl_H + +#include "pointFieldFwd.H" +#include "Tuple2.H" + +// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // + +namespace Foam +{ + +// Forward declaration of classes +class objectRegistry; +class dictionary; +class mapPolyMesh; + +/*---------------------------------------------------------------------------*\ + Class residualControl Declaration +\*---------------------------------------------------------------------------*/ + +class residualControl +{ +protected: + + // Private data + + //- Name of this object + word name_; + + //- Reference to object registry + const objectRegistry& obr_; + + //- On/off switch - on if obr_ is an fvMesh object + bool active_; + + //- List of variable name vs max residual + List > maxResiduals_; + + //- Flag to indicate whether convergence criteria have been met + bool criteriaSatisfied_; + + + // Protected Member Functions + + //- Perform residual control checks + bool checkCriteria(const bool output) const; + + //- Disallow default bitwise copy construct + residualControl(const residualControl&); + + //- Disallow default bitwise assignment + void operator=(const residualControl&); + + +public: + + //- Runtime type information + TypeName("residualControl"); + + + // Constructors + + //- Construct for given objectRegistry and dictionary. + // Allow the possibility to load fields from files + residualControl + ( + const word& name, + const objectRegistry& obr, + const dictionary& dict, + const bool loadFromFilesUnused = false + ); + + + //- Destructor + virtual ~residualControl(); + + + // Member Functions + + //- Return name of the system call set + virtual const word& name() const + { + return name_; + } + + //- Read the system calls + virtual void read(const dictionary&); + + //- Execute the "executeCalls" at each time-step + virtual void execute(); + + //- Execute the "endCalls" at the final time-loop + virtual void end(); + + //- Write, execute the "writeCalls" + virtual void write(); + + //- Update for changes of mesh + virtual void updateMesh(const mapPolyMesh&) + {} + + //- Update for changes of mesh + virtual void movePoints(const pointField&) + {} +}; + + +// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // + +} // End namespace Foam + +// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // + +#endif + +// ************************************************************************* // diff --git a/src/postProcessing/functionObjects/residualControl/residualControlFunctionObject.C b/src/postProcessing/functionObjects/residualControl/residualControlFunctionObject.C new file mode 100644 index 0000000000..1813e2063e --- /dev/null +++ b/src/postProcessing/functionObjects/residualControl/residualControlFunctionObject.C @@ -0,0 +1,42 @@ +/*---------------------------------------------------------------------------*\ + ========= | + \\ / F ield | OpenFOAM: The Open Source CFD Toolbox + \\ / O peration | + \\ / A nd | Copyright (C) 2010-2010 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 "residualControlFunctionObject.H" + +// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * // + +namespace Foam +{ + defineNamedTemplateTypeNameAndDebug(residualControlFunctionObject, 0); + + addToRunTimeSelectionTable + ( + functionObject, + residualControlFunctionObject, + dictionary + ); +} + +// ************************************************************************* // diff --git a/src/postProcessing/functionObjects/residualControl/residualControlFunctionObject.H b/src/postProcessing/functionObjects/residualControl/residualControlFunctionObject.H new file mode 100644 index 0000000000..19981b40f6 --- /dev/null +++ b/src/postProcessing/functionObjects/residualControl/residualControlFunctionObject.H @@ -0,0 +1,54 @@ +/*---------------------------------------------------------------------------*\ + ========= | + \\ / F ield | OpenFOAM: The Open Source CFD Toolbox + \\ / O peration | + \\ / A nd | Copyright (C) 2010-2010 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 . + +Typedef + Foam::residualControlFunctionObject + +Description + FunctionObject wrapper around residualControl to allow them to be created + via the functions entry within controlDict. + +SourceFiles + residualControlFunctionObject.C + +\*---------------------------------------------------------------------------*/ + +#ifndef residualControlFunctionObject_H +#define residualControlFunctionObject_H + +#include "residualControl.H" +#include "OutputFilterFunctionObject.H" + +// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // + +namespace Foam +{ + typedef OutputFilterFunctionObject + residualControlFunctionObject; +} + +// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // + +#endif + +// ************************************************************************* //