Homec4science
Diffusion µSpectre (feat/refactoring_FFT_FieldCollection_T1851) Browse

muSpectre/language_bindings/python/bind_py_solvers.cc
b3f3772f45b1feat/refactoring_FFT_Fi…

Last Change
Raw File

bind_py_solvers.cc
View Options

/**
* @file bind_py_solver.cc
*
* @author Till Junge <till.junge@epfl.ch>
*
* @date 09 Jan 2018
*
* @brief python bindings for the muSpectre solvers
*
* Copyright © 2018 Till Junge
*
* µSpectre 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, or (at
* your option) any later version.
*
* µSpectre 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 GNU Emacs; see the file COPYING. If not, write to the
* Free Software Foundation, Inc., 59 Temple Place - Suite 330,
* Boston, MA 02111-1307, USA.
*/
#include "common/common.hh"
#include "solver/solvers.hh"
#include "solver/solver_cg.hh"
#include "solver/solver_cg_eigen.hh"
#include <pybind11/pybind11.h>
#include <pybind11/stl.h>
#include <pybind11/eigen.h>
using namespace muSpectre;
namespace py=pybind11;
using namespace pybind11::literals;
/**
* Solvers instanciated for systems with equal spatial and material dimension
*/
template <Dim_t sdim, class Solver>
void add_iterative_solver_helper(py::module & mod, std::string name_start) {
using sys = SystemBase<sdim>;
std::stringstream name{};
name << name_start << '_' << sdim << 'd';
py::class_<Solver, typename Solver::Parent>(mod, name.str().c_str())
.def(py::init<sys&, Real, Uint, bool>(),
"cell"_a,
"tol"_a,
"maxiter"_a,
"verbose"_a=false)
.def("name", &Solver::name);
mod.def(name_start.c_str(),
[](sys& cell, Real tol, Uint maxiter, bool verbose) {
return std::make_unique<Solver>(cell, tol, maxiter, verbose);
},
"cell"_a,
"tol"_a,
"maxiter"_a,
"verbose"_a=false);
}
template <Dim_t sdim>
void add_iterative_solver_dispatcher(py::module & mod) {
std::stringstream name{};
name << "SolverBase_" << sdim << 'd';
py::class_<SolverBase<sdim>>(mod, name.str().c_str());
add_iterative_solver_helper<sdim, SolverCG<sdim>>(mod, "SolverCG");
add_iterative_solver_helper<sdim, SolverCGEigen<sdim>>(mod, "SolverCGEigen");
add_iterative_solver_helper<sdim, SolverGMRESEigen<sdim>>(mod, "SolverGMRESEigen");
add_iterative_solver_helper<sdim, SolverBiCGSTABEigen<sdim>>(mod, "SolverBiCGSTABEigen");
add_iterative_solver_helper<sdim, SolverDGMRESEigen<sdim>>(mod, "SolverDGMRESEigen");
add_iterative_solver_helper<sdim, SolverMINRESEigen<sdim>>(mod, "SolverMINRESEigen");
}
void add_iterative_solver(py::module & mod) {
add_iterative_solver_dispatcher< twoD>(mod);
add_iterative_solver_dispatcher<threeD>(mod);
}
template <Dim_t sdim>
void add_newton_cg_helper(py::module & mod) {
const char name []{"newton_cg"};
constexpr Dim_t mdim{sdim};
using sys = SystemBase<sdim, mdim>;
using solver = SolverBase<sdim, mdim>;
using grad = Grad_t<sdim>;
using grad_vec = GradIncrements<sdim>;
mod.def(name,
[](sys & s, const grad & g, solver & so, Real nt,
Real eqt, Dim_t verb) -> OptimizeResult {
return newton_cg(s, g, so, nt, eqt, verb);
},
"system"_a,
"ΔF₀"_a,
"solver"_a,
"newton_tol"_a,
"equil_tol"_a,
"verbose"_a=0);
mod.def(name,
[](sys & s, const grad_vec & g, solver & so, Real nt,
Real eqt, Dim_t verb) -> std::vector<OptimizeResult> {
return newton_cg(s, g, so, nt, eqt, verb);
},
"system"_a,
"ΔF₀"_a,
"solver"_a,
"newton_tol"_a,
"equilibrium_tol"_a,
"verbose"_a=0);
}
template <Dim_t sdim>
void add_de_geus_helper(py::module & mod) {
const char name []{"de_geus"};
constexpr Dim_t mdim{sdim};
using sys = SystemBase<sdim, mdim>;
using solver = SolverBase<sdim, mdim>;
using grad = Grad_t<sdim>;
using grad_vec = GradIncrements<sdim>;
mod.def(name,
[](sys & s, const grad & g, solver & so, Real nt,
Real eqt, Dim_t verb) -> OptimizeResult {
return de_geus(s, g, so, nt, eqt, verb);
},
"system"_a,
"ΔF₀"_a,
"solver"_a,
"newton_tol"_a,
"equilibrium_tol"_a,
"verbose"_a=0);
mod.def(name,
[](sys & s, const grad_vec & g, solver & so, Real nt,
Real eqt, Dim_t verb) -> std::vector<OptimizeResult> {
return de_geus(s, g, so, nt, eqt, verb);
},
"system"_a,
"ΔF₀"_a,
"solver"_a,
"newton_tol"_a,
"equilibrium_tol"_a,
"verbose"_a=0);
}
template <Dim_t dim>
void add_solver_helper(py::module & mod) {
add_newton_cg_helper<dim>(mod);
add_de_geus_helper <dim>(mod);
}
void add_solvers(py::module & mod) {
auto solvers{mod.def_submodule("solvers")};
solvers.doc() = "bindings for solvers";
py::class_<OptimizeResult>(mod, "OptimizeResult")
.def_readwrite("grad", &OptimizeResult::grad)
.def_readwrite("stress", &OptimizeResult::stress)
.def_readwrite("success", &OptimizeResult::success)
.def_readwrite("status", &OptimizeResult::status)
.def_readwrite("message", &OptimizeResult::message)
.def_readwrite("nb_it", &OptimizeResult::nb_it)
.def_readwrite("nb_fev", &OptimizeResult::nb_fev);
add_iterative_solver(solvers);
add_solver_helper<twoD >(solvers);
add_solver_helper<threeD>(solvers);
}
c4science · Help