Homec4science
Diffusion µSpectre (feat/documentation) Browse

muSpectre/src/solver/solver_cg.cc
1fa724724806feat/documentation

Last Change
Raw File

solver_cg.cc
View Options

/**
* file solver_cg.cc
*
* @author Till Junge <till.junge@epfl.ch>
*
* @date 20 Dec 2017
*
* @brief Implementation of cg solver
*
* @section LICENCE
*
* Copyright (C) 2017 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 <iomanip>
#include <cmath>
#include "solver/solver_cg.hh"
#include "solver/solver_error.hh"
namespace muSpectre {
/* ---------------------------------------------------------------------- */
template <Dim_t DimS, Dim_t DimM>
SolverCG<DimS, DimM>::SolverCG(Ccoord resolutions, Real tol, Uint maxiter,
bool verbose)
:Parent(resolutions),
r_k{make_field<Field_t>("residual r_k", this->collection)},
p_k{make_field<Field_t>("search direction r_k", this->collection)},
Ap_k{make_field<Field_t>("Effect of tangent A*p_k", this->collection)},
tol{tol}, maxiter{maxiter}, verbose{verbose}
{}
/* ---------------------------------------------------------------------- */
template <Dim_t DimS, Dim_t DimM>
void SolverCG<DimS, DimM>::solve(const Fun_t& tangent_effect,
const Field_t & rhs,
Field_t & x_f) {
// Following implementation of algorithm 5.2 in Nocedal's Numerical Optimization (p. 112)
auto r = this->r_k.eigen();
auto p = this->p_k.eigen();
auto Ap = this->Ap_k.eigen();
auto x = x_f.eigen();
// initialisation of algo
tangent_effect(x_f, this->r_k);
r -= rhs.eigen();
p = -r;
this->converged = false;
Real rdr = (r*r).sum();
Real tol2 = ipow(this->tol,2);
size_t count_width{}; // for output formatting in verbose case
if (this->verbose) {
count_width = size_t(std::log10(this->maxiter))+1;
}
for (Uint i = 0; i < this->maxiter && rdr > tol2; ++i) {
tangent_effect(this->p_k, this->Ap_k);
Real alpha = rdr/(p*Ap).sum();
x += alpha * p;
r += alpha * Ap;
Real new_rdr = (r*r).sum();
Real beta = new_rdr/rdr;
rdr = new_rdr;
if (this->verbose) {
std::cout << " at CG step " << std::setw(count_width) << i
<< ": |r| = " << std::setw(17) << std::sqrt(rdr)
<< ", cg_tol = " << this->tol << std::endl;
}
p = -r+beta*p;
}
if (rdr < tol2) {
this->converged=true;
} else {
throw ConvergenceError("Conjugate gradient has not converged");
}
}
/* ---------------------------------------------------------------------- */
template <Dim_t DimS, Dim_t DimM>
typename SolverCG<DimS, DimM>::Tg_req_t
SolverCG<DimS, DimM>::get_tangent_req() const {
return tangent_requirement;
}
template class SolverCG<twoD, twoD>;
//template class SolverCG<twoD, threeD>;
template class SolverCG<threeD, threeD>;
} // muSpectre
c4science · Help