Homec4science
Diffusion akantu (features/11-computation-of-contact-energy-with-getenergy-contact) Browse

rAKA/src/model/common/time_step_solvers/time_step_solver.hh
01d5a6530006features/11-computation…

Last Change
Raw File

time_step_solver.hh
View Options

/**
* Copyright (©) 2010-2023 EPFL (Ecole Polytechnique Fédérale de Lausanne)
* Laboratory (LSMS - Laboratoire de Simulation en Mécanique des Solides)
*
* This file is part of Akantu
*
* 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_array.hh"
#include "integration_scheme.hh"
#include "parameter_registry.hh"
#include "solver_callback.hh"
/* -------------------------------------------------------------------------- */
#ifndef AKANTU_TIME_STEP_SOLVER_HH_
#define AKANTU_TIME_STEP_SOLVER_HH_
namespace akantu {
class DOFManager;
class NonLinearSolver;
} // namespace akantu
namespace akantu {
class TimeStepSolver : public ParameterRegistry, public SolverCallback {
/* ------------------------------------------------------------------------ */
/* Constructors/Destructors */
/* ------------------------------------------------------------------------ */
public:
TimeStepSolver(DOFManager & dof_manager, const TimeStepSolverType & type,
NonLinearSolver & non_linear_solver,
SolverCallback & solver_callback, const ID & id);
~TimeStepSolver() override;
/* ------------------------------------------------------------------------ */
/* Methods */
/* ------------------------------------------------------------------------ */
public:
/// solves on step
virtual void solveStep(SolverCallback & solver_callback) = 0;
/// register an integration scheme for a given dof
void setIntegrationScheme(const ID & dof_id,
const IntegrationSchemeType & type,
IntegrationScheme::SolutionType solution_type =
IntegrationScheme::_not_defined);
/// register an integration scheme for a given dof
void setIntegrationScheme(const ID & dof_id,
std::unique_ptr<IntegrationScheme> & scheme,
IntegrationScheme::SolutionType solution_type =
IntegrationScheme::_not_defined);
virtual IntegrationScheme & getIntegrationScheme(const ID & /*dof_id*/) {
AKANTU_TO_IMPLEMENT();
}
protected:
/// register an integration scheme for a given dof
virtual std::unique_ptr<IntegrationScheme>
getIntegrationSchemeInternal(const ID & dof_id,
const IntegrationSchemeType & type,
IntegrationScheme::SolutionType solution_type =
IntegrationScheme::_not_defined) = 0;
virtual void
setIntegrationSchemeInternal(const ID & dof_id,
std::unique_ptr<IntegrationScheme> & scheme,
IntegrationScheme::SolutionType solution_type =
IntegrationScheme::_not_defined) = 0;
public:
/// replies if a integration scheme has been set
virtual bool hasIntegrationScheme(const ID & dof_id) const = 0;
/* ------------------------------------------------------------------------ */
/* Solver Callback interface */
/* ------------------------------------------------------------------------ */
public:
/// implementation of the SolverCallback::getMatrixType()
MatrixType getMatrixType(const ID & /*unused*/) const final {
return _mt_not_defined;
}
/// implementation of the SolverCallback::predictor()
void predictor() override;
/// implementation of the SolverCallback::corrector()
void corrector() override;
/// implementation of the SolverCallback::assembleJacobian()
void assembleMatrix(const ID & matrix_id) override;
/// implementation of the SolverCallback::assembleJacobian()
void assembleLumpedMatrix(const ID & matrix_id) override;
/// implementation of the SolverCallback::assembleResidual()
void assembleResidual() override;
/// implementation of the SolverCallback::assembleResidual()
void assembleResidual(const ID & residual_part) override;
void beforeSolveStep() override;
void afterSolveStep(bool converged = true) override;
bool canSplitResidual() const override {
return solver_callback->canSplitResidual();
}
/* ------------------------------------------------------------------------ */
/* Accessor */
/* ------------------------------------------------------------------------ */
public:
AKANTU_GET_MACRO(TimeStep, time_step, Real);
AKANTU_SET_MACRO(TimeStep, time_step, Real);
AKANTU_GET_MACRO(NonLinearSolver, non_linear_solver, const NonLinearSolver &);
AKANTU_GET_MACRO_NOT_CONST(NonLinearSolver, non_linear_solver,
NonLinearSolver &);
protected:
MatrixType getCommonMatrixType();
/* ------------------------------------------------------------------------ */
/* Class Members */
/* ------------------------------------------------------------------------ */
protected:
ID id;
/// Underlying dof manager containing the dof to treat
DOFManager & _dof_manager;
/// Type of solver
TimeStepSolverType type;
/// The time step for this solver
Real time_step;
/// Temporary storage for solver callback
SolverCallback * solver_callback;
/// NonLinearSolver used by this tome step solver
NonLinearSolver & non_linear_solver;
/// List of required matrices
std::map<std::string, MatrixType> needed_matrices;
/// specifies if the solvers gives to full solution or just the increment of
/// solution
bool is_solution_increment{true};
};
} // namespace akantu
#endif /* AKANTU_TIME_STEP_SOLVER_HH_ */
c4science · Help