Skip to content
Snippets Groups Projects
Commit c380eb13 authored by Jakub Klinkovský's avatar Jakub Klinkovský
Browse files

Cosmetic changes in IterativeSolver

parent 52244d6b
No related branches found
No related tags found
1 merge request!47Linear solvers
Hide whitespace changes
Inline Side-by-side
src/TNL/Solvers/IterativeSolver.h
+ 17
− 20
View file @ c380eb13
......@@ -2,7 +2,7 @@
IterativeSolver.h - description
-------------------
begin : Oct 19, 2012
copyright : (C) 2012 by Tomas Oberhuber
copyright : (C) 2012 by Tomas Oberhuber et al.
email : tomas.oberhuber@fjfi.cvut.cz
***************************************************************************/
......@@ -10,6 +10,8 @@
#pragma once
#include <limits>
#include <TNL/Config/ConfigDescription.h>
#include <TNL/Config/ParameterContainer.h>
#include <TNL/Solvers/IterativeSolverMonitor.h>
......@@ -22,17 +24,16 @@ template< typename Real,
typename SolverMonitor = IterativeSolverMonitor< Real, Index > >
class IterativeSolver
{
public:
public:
using SolverMonitorType = SolverMonitor;
using SolverMonitorType = SolverMonitor;
IterativeSolver();
IterativeSolver() = default;
static void configSetup( Config::ConfigDescription& config,
const String& prefix = "" );
bool setup( const Config::ParameterContainer& parameters,
const String& prefix = "" );
const String& prefix = "" );
void setMaxIterations( const Index& maxIterations );
......@@ -70,27 +71,23 @@ class IterativeSolver
void refreshSolverMonitor( bool force = false );
protected:
Index maxIterations = 1000000000;
protected:
Index maxIterations;
Index minIterations;
Index minIterations = 0;
Index currentIteration;
Index currentIteration = 0;
Real convergenceResidue;
Real convergenceResidue = 1e-6;
/****
* If the current residue is over divergenceResidue the solver is stopped.
*/
Real divergenceResidue;
// If the current residue is greater than divergenceResidue, the solver is stopped.
Real divergenceResidue = std::numeric_limits< float >::max();
Real currentResidue;
Real currentResidue = 0;
SolverMonitor* solverMonitor;
SolverMonitor* solverMonitor = nullptr;
Index refreshRate;
Index refreshRate = 1;
};
} // namespace Solvers
......
src/TNL/Solvers/IterativeSolver_impl.h
+ 60
− 41
View file @ c380eb13
......@@ -2,7 +2,7 @@
IterativeSolver_impl.h - description
-------------------
begin : Oct 19, 2012
copyright : (C) 2012 by Tomas Oberhuber
copyright : (C) 2012 by Tomas Oberhuber et al.
email : tomas.oberhuber@fjfi.cvut.cz
***************************************************************************/
......@@ -11,34 +11,21 @@
#pragma once
#include <cmath>
#include <float.h>
#include <limits>
#include "IterativeSolver.h"
namespace TNL {
namespace Solvers {
namespace Solvers {
template< typename Real, typename Index, typename SolverMonitor >
IterativeSolver< Real, Index, SolverMonitor >::IterativeSolver()
: maxIterations( 1000000000 ),
minIterations( 0 ),
currentIteration( 0 ),
convergenceResidue( 1.0e-6 ),
divergenceResidue( DBL_MAX ),
currentResidue( 0 ),
solverMonitor( 0 ),
refreshRate( 1 )
{
};
template< typename Real, typename Index, typename SolverMonitor >
void IterativeSolver< Real, Index, SolverMonitor >::configSetup( Config::ConfigDescription& config,
const String& prefix )
void
IterativeSolver< Real, Index, SolverMonitor >::
configSetup( Config::ConfigDescription& config,
const String& prefix )
{
config.addEntry< int > ( prefix + "max-iterations", "Maximal number of iterations the solver may perform.", 1000000000 );
config.addEntry< int > ( prefix + "min-iterations", "Minimal number of iterations the solver must perform.", 0 );
// The default value for the convergence residue MUST be zero since not in all problems we want to stop the solver
// when we reach a state near a steady state. This can be only temporary if, for example, when the boundary conditions
// are time dependent (growing velocity at inlet starting from 0).
......@@ -49,8 +36,10 @@ void IterativeSolver< Real, Index, SolverMonitor >::configSetup( Config::ConfigD
}
template< typename Real, typename Index, typename SolverMonitor >
bool IterativeSolver< Real, Index, SolverMonitor >::setup( const Config::ParameterContainer& parameters,
const String& prefix )
bool
IterativeSolver< Real, Index, SolverMonitor >::
setup( const Config::ParameterContainer& parameters,
const String& prefix )
{
this->setMaxIterations( parameters.getParameter< int >( "max-iterations" ) );
this->setMinIterations( parameters.getParameter< int >( "min-iterations" ) );
......@@ -62,40 +51,51 @@ bool IterativeSolver< Real, Index, SolverMonitor >::setup( const Config::Paramet
}
template< typename Real, typename Index, typename SolverMonitor >
void IterativeSolver< Real, Index, SolverMonitor >::setMaxIterations( const Index& maxIterations )
void
IterativeSolver< Real, Index, SolverMonitor >::
setMaxIterations( const Index& maxIterations )
{
this->maxIterations = maxIterations;
}
template< typename Real, typename Index, typename SolverMonitor >
const Index& IterativeSolver< Real, Index, SolverMonitor >::getMaxIterations() const
const Index&
IterativeSolver< Real, Index, SolverMonitor >::
getMaxIterations() const
{
return this->maxIterations;
}
template< typename Real, typename Index, typename SolverMonitor >
void IterativeSolver< Real, Index, SolverMonitor >::setMinIterations( const Index& minIterations )
void
IterativeSolver< Real, Index, SolverMonitor >::
setMinIterations( const Index& minIterations )
{
this->minIterations = minIterations;
}
template< typename Real, typename Index, typename SolverMonitor >
const Index& IterativeSolver< Real, Index, SolverMonitor >::getMinIterations() const
const Index&
IterativeSolver< Real, Index, SolverMonitor >::
getMinIterations() const
{
return this->minIterations;
}
template< typename Real, typename Index, typename SolverMonitor >
void IterativeSolver< Real, Index, SolverMonitor >::resetIterations()
void
IterativeSolver< Real, Index, SolverMonitor >::
resetIterations()
{
this->currentIteration = 0;
if( this->solverMonitor )
this->solverMonitor->setIterations( 0 );
}
template< typename Real, typename Index, typename SolverMonitor >
bool IterativeSolver< Real, Index, SolverMonitor >::nextIteration()
bool
IterativeSolver< Real, Index, SolverMonitor >::
nextIteration()
{
// this->checkNextIteration() must be called before the iteration counter is incremented
bool result = this->checkNextIteration();
......@@ -108,7 +108,9 @@ bool IterativeSolver< Real, Index, SolverMonitor >::nextIteration()
}
template< typename Real, typename Index, typename SolverMonitor >
bool IterativeSolver< Real, Index, SolverMonitor >::checkNextIteration()
bool
IterativeSolver< Real, Index, SolverMonitor >::
checkNextIteration()
{
this->refreshSolverMonitor();
......@@ -116,7 +118,7 @@ bool IterativeSolver< Real, Index, SolverMonitor >::checkNextIteration()
this->getIterations() > this->getMaxIterations() ||
( this->getResidue() > this->getDivergenceResidue() && this->getIterations() >= this->getMinIterations() ) ||
( this->getResidue() < this->getConvergenceResidue() && this->getIterations() >= this->getMinIterations() ) )
return false;
return false;
return true;
}
......@@ -158,32 +160,41 @@ getIterations() const
}
template< typename Real, typename Index, typename SolverMonitor >
void IterativeSolver< Real, Index, SolverMonitor >::setConvergenceResidue( const Real& convergenceResidue )
void
IterativeSolver< Real, Index, SolverMonitor >::
setConvergenceResidue( const Real& convergenceResidue )
{
this->convergenceResidue = convergenceResidue;
}
template< typename Real, typename Index, typename SolverMonitor >
const Real& IterativeSolver< Real, Index, SolverMonitor >::getConvergenceResidue() const
const Real&
IterativeSolver< Real, Index, SolverMonitor >::
getConvergenceResidue() const
{
return this->convergenceResidue;
}
template< typename Real, typename Index, typename SolverMonitor >
void IterativeSolver< Real, Index, SolverMonitor >::setDivergenceResidue( const Real& divergenceResidue )
void
IterativeSolver< Real, Index, SolverMonitor >::
setDivergenceResidue( const Real& divergenceResidue )
{
this->divergenceResidue = divergenceResidue;
}
template< typename Real, typename Index, typename SolverMonitor >
const Real& IterativeSolver< Real, Index, SolverMonitor >::getDivergenceResidue() const
const Real&
IterativeSolver< Real, Index, SolverMonitor >::
getDivergenceResidue() const
{
return this->divergenceResidue;
}
template< typename Real, typename Index, typename SolverMonitor >
void IterativeSolver< Real, Index, SolverMonitor >::setResidue( const Real& residue )
void
IterativeSolver< Real, Index, SolverMonitor >::
setResidue( const Real& residue )
{
this->currentResidue = residue;
if( this->solverMonitor )
......@@ -191,26 +202,34 @@ void IterativeSolver< Real, Index, SolverMonitor >::setResidue( const Real& resi
}
template< typename Real, typename Index, typename SolverMonitor >
const Real& IterativeSolver< Real, Index, SolverMonitor >::getResidue() const
const Real&
IterativeSolver< Real, Index, SolverMonitor >::
getResidue() const
{
return this->currentResidue;
}
// TODO: setting refresh rate should be done in SolverStarter::setup (it's not a parameter of the IterativeSolver)
template< typename Real, typename Index, typename SolverMonitor >
void IterativeSolver< Real, Index, SolverMonitor >::setRefreshRate( const Index& refreshRate )
void
IterativeSolver< Real, Index, SolverMonitor >::
setRefreshRate( const Index& refreshRate )
{
this->refreshRate = refreshRate;
}
template< typename Real, typename Index, typename SolverMonitor >
void IterativeSolver< Real, Index, SolverMonitor >::setSolverMonitor( SolverMonitorType& solverMonitor )
void
IterativeSolver< Real, Index, SolverMonitor >::
setSolverMonitor( SolverMonitorType& solverMonitor )
{
this->solverMonitor = &solverMonitor;
}
template< typename Real, typename Index, typename SolverMonitor >
void IterativeSolver< Real, Index, SolverMonitor >::refreshSolverMonitor( bool force )
void
IterativeSolver< Real, Index, SolverMonitor >::
refreshSolverMonitor( bool force )
{
if( this->solverMonitor )
{
......
src/TNL/Solvers/ODE/ExplicitSolver_impl.h
+ 2
− 0
View file @ c380eb13
......@@ -10,6 +10,8 @@
#pragma once
#include <cfloat>
namespace TNL {
namespace Solvers {
namespace ODE {
......
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment