Homec4science
Diffusion akantu (features/issue-template) Browse

rAKA/src/model/common/non_linear_solver/non_linear_solver.hh
5632dcaaf3f8features/issue-template

Last Change
Raw File

non_linear_solver.hh
View Options

/**
* @file non_linear_solver.hh
*
* @author Nicolas Richart <nicolas.richart@epfl.ch>
*
* @date creation: Fri Jun 18 2010
* @date last modification: Wed Mar 27 2019
*
* @brief Non linear solver interface
*
*
* @section LICENSE
*
* Copyright (©) 2010-2021 EPFL (Ecole Polytechnique Fédérale de Lausanne)
* Laboratory (LSMS - Laboratoire de Simulation en Mécanique des Solides)
*
* Akantu is free software: you can redistribute it and/or modify it under the
* terms of the GNU Lesser General Public License as published by the Free
* Software Foundation, either version 3 of the License, or (at your option) any
* later version.
*
* Akantu 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 Lesser General Public License for more
* details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with Akantu. If not, see <http://www.gnu.org/licenses/>.
*
*/
/* -------------------------------------------------------------------------- */
#include "aka_common.hh"
#include "parsable.hh"
/* -------------------------------------------------------------------------- */
#include <set>
/* -------------------------------------------------------------------------- */
#ifndef AKANTU_NON_LINEAR_SOLVER_HH_
#define AKANTU_NON_LINEAR_SOLVER_HH_
namespace akantu {
class DOFManager;
class SolverCallback;
} // namespace akantu
namespace akantu {
class NonLinearSolver : public Parsable {
/* ------------------------------------------------------------------------ */
/* Constructors/Destructors */
/* ------------------------------------------------------------------------ */
public:
NonLinearSolver(DOFManager & dof_manager,
const NonLinearSolverType & non_linear_solver_type,
const ID & id = "non_linear_solver");
~NonLinearSolver() override;
/* ------------------------------------------------------------------------ */
/* Methods */
/* ------------------------------------------------------------------------ */
public:
/// solve the system described by the jacobian matrix, and rhs contained in
/// the dof manager
virtual void solve(SolverCallback & callback) = 0;
/// intercept the call to set for options
template <typename T> void set(const ID & param, T && t) {
if (has_internal_set_param) {
set_param(param, std::to_string(t));
} else {
ParameterRegistry::set(param, t);
}
}
protected:
void checkIfTypeIsSupported();
void assembleResidual(SolverCallback & callback);
/// internal set param for solvers that should intercept the parameters
virtual void set_param(const ID & /*param*/, const std::string & /*value*/) {}
/* ------------------------------------------------------------------------ */
/* Class Members */
/* ------------------------------------------------------------------------ */
protected:
ID id;
DOFManager & _dof_manager;
/// type of non linear solver
NonLinearSolverType non_linear_solver_type;
/// list of supported non linear solver types
std::set<NonLinearSolverType> supported_type;
/// specifies if the set param should be redirected
bool has_internal_set_param{false};
};
namespace debug {
class NLSNotConvergedException : public Exception {
public:
NLSNotConvergedException(Real threshold, UInt niter, Real error)
: Exception("The non linear solver did not converge."),
threshold(threshold), niter(niter), error(error) {}
Real threshold;
UInt niter;
Real error;
};
} // namespace debug
} // namespace akantu
#endif /* AKANTU_NON_LINEAR_SOLVER_HH_ */
c4science · Help