diff --git a/.clang-format b/.clang-format index a8db080..56d3eef 100644 --- a/.clang-format +++ b/.clang-format @@ -1,5 +1,6 @@ AccessModifierOffset: -1 SpacesBeforeTrailingComments: 2 NamespaceIndentation: All SortIncludes: false PointerAlignment: Middle +AlwaysBreakTemplateDeclarations: true diff --git a/bin/demonstrator1.cc b/bin/demonstrator1.cc index afebd75..75922ce 100644 --- a/bin/demonstrator1.cc +++ b/bin/demonstrator1.cc @@ -1,142 +1,142 @@ /** * @file demonstrator1.cc * * @author Till Junge * * @date 03 Jan 2018 * * @brief larger problem to show off * * Copyright © 2018 Till Junge * * µSpectre 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, 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 Lesser General Public License * along with µSpectre; see the file COPYING. If not, write to the * Free Software Foundation, Inc., 59 Temple Place - Suite 330, * * Boston, MA 02111-1307, USA. * * Additional permission under GNU GPL version 3 section 7 * * If you modify this Program, or any covered work, by linking or combining it * with proprietary FFT implementations or numerical libraries, containing parts * covered by the terms of those libraries' licenses, the licensors of this * Program grant you additional permission to convey the resulting work. */ #include #include #include #include "external/cxxopts.hpp" #include "common/common.hh" #include "common/ccoord_operations.hh" #include "cell/cell_factory.hh" #include "materials/material_linear_elastic1.hh" #include "solver/deprecated_solvers.hh" #include "solver/deprecated_solver_cg.hh" using opt_ptr = std::unique_ptr; -opt_ptr parse_args(int argc, char **argv) { +opt_ptr parse_args(int argc, char ** argv) { opt_ptr options = std::make_unique(argv[0], "Tests MPI fft scalability"); try { options->add_options()("0,N0", "number of rows", cxxopts::value(), "N0")("h,help", "print help")( "positional", "Positional arguments: these are the arguments that are entered " "without an option", cxxopts::value>()); options->parse_positional(std::vector{"N0", "positional"}); options->parse(argc, argv); if (options->count("help")) { std::cout << options->help({"", "Group"}) << std::endl; exit(0); } if (options->count("N0") != 1) { throw cxxopts::OptionException("Parameter N0 missing"); } else if ((*options)["N0"].as() % 2 != 1) { throw cxxopts::OptionException("N0 must be odd"); } else if (options->count("positional") > 0) { throw cxxopts::OptionException("There are too many positional arguments"); } - } catch (const cxxopts::OptionException &e) { + } catch (const cxxopts::OptionException & e) { std::cout << "Error parsing options: " << e.what() << std::endl; exit(1); } return options; } using namespace muSpectre; -int main(int argc, char *argv[]) { +int main(int argc, char * argv[]) { banner("demonstrator1", 2018, "Till Junge "); auto options{parse_args(argc, argv)}; - auto &opt{*options}; + auto & opt{*options}; const Dim_t size{opt["N0"].as()}; constexpr Real fsize{1.}; constexpr Dim_t dim{3}; const Dim_t nb_dofs{ipow(size, dim) * ipow(dim, 2)}; std::cout << "Number of dofs: " << nb_dofs << std::endl; constexpr Formulation form{Formulation::finite_strain}; const Rcoord_t lengths{CcoordOps::get_cube(fsize)}; const Ccoord_t resolutions{CcoordOps::get_cube(size)}; auto cell{make_cell(resolutions, lengths, form)}; constexpr Real E{1.0030648180242636}; constexpr Real nu{0.29930675909878679}; using Material_t = MaterialLinearElastic1; - auto &Material_soft{Material_t::make(cell, "soft", E, nu)}; - auto &Material_hard{Material_t::make(cell, "hard", 10 * E, nu)}; + auto & Material_soft{Material_t::make(cell, "soft", E, nu)}; + auto & Material_hard{Material_t::make(cell, "hard", 10 * E, nu)}; int counter{0}; - for (const auto &&pixel : cell) { + for (const auto && pixel : cell) { int sum = 0; for (Dim_t i = 0; i < dim; ++i) { sum += pixel[i] * 2 / resolutions[i]; } if (sum == 0) { Material_hard.add_pixel(pixel); counter++; } else { Material_soft.add_pixel(pixel); } } std::cout << counter << " Pixel out of " << cell.size() << " are in the hard material" << std::endl; cell.initialise(FFT_PlanFlags::measure); constexpr Real newton_tol{1e-4}; constexpr Real cg_tol{1e-7}; const Uint maxiter = nb_dofs; Grad_t DeltaF{Grad_t::Zero()}; DeltaF(0, 1) = .1; Dim_t verbose{1}; auto start = std::chrono::high_resolution_clock::now(); GradIncrements grads{DeltaF}; DeprecatedSolverCG cg{cell, cg_tol, maxiter, static_cast(verbose)}; deprecated_newton_cg(cell, grads, cg, newton_tol, verbose); std::chrono::duration dur = std::chrono::high_resolution_clock::now() - start; std::cout << "Resolution time = " << dur.count() << "s" << std::endl; return 0; } diff --git a/bin/demonstrator2.cc b/bin/demonstrator2.cc index 902f8dc..e10dddc 100644 --- a/bin/demonstrator2.cc +++ b/bin/demonstrator2.cc @@ -1,97 +1,97 @@ /** * @file demonstrator1.cc * * @author Till Junge * * @date 03 Jan 2018 * * @brief larger problem to show off * * Copyright © 2018 Till Junge * * µSpectre 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, 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 Lesser General Public License * along with µSpectre; see the file COPYING. If not, write to the * Free Software Foundation, Inc., 59 Temple Place - Suite 330, * * Boston, MA 02111-1307, USA. * * Additional permission under GNU GPL version 3 section 7 * * If you modify this Program, or any covered work, by linking or combining it * with proprietary FFT implementations or numerical libraries, containing parts * covered by the terms of those libraries' licenses, the licensors of this * Program grant you additional permission to convey the resulting work. */ #include #include #include #include "common/common.hh" #include "common/ccoord_operations.hh" #include "cell/cell_factory.hh" #include "materials/material_linear_elastic1.hh" #include "solver/solvers.hh" #include "solver/solver_cg.hh" using namespace muSpectre; int main() { banner("demonstrator1", 2018, "Till Junge "); constexpr Dim_t dim{2}; constexpr Formulation form{Formulation::finite_strain}; const Rcoord_t lengths{5.2, 8.3}; const Ccoord_t resolutions{5, 7}; auto cell{make_cell(resolutions, lengths, form)}; constexpr Real E{1.0030648180242636}; constexpr Real nu{0.29930675909878679}; using Material_t = MaterialLinearElastic1; - auto &soft{Material_t::make(cell, "soft", E, nu)}; - auto &hard{Material_t::make(cell, "hard", 10 * E, nu)}; + auto & soft{Material_t::make(cell, "soft", E, nu)}; + auto & hard{Material_t::make(cell, "hard", 10 * E, nu)}; int counter{0}; - for (const auto &&pixel : cell) { + for (const auto && pixel : cell) { if (counter < 3) { hard.add_pixel(pixel); counter++; } else { soft.add_pixel(pixel); } } std::cout << counter << " Pixel out of " << cell.size() << " are in the hard material" << std::endl; cell.initialise(); constexpr Real newton_tol{1e-4}; constexpr Real cg_tol{1e-7}; const size_t maxiter = 100; Eigen::MatrixXd DeltaF{Eigen::MatrixXd::Zero(dim, dim)}; DeltaF(0, 1) = .1; Dim_t verbose{1}; auto start = std::chrono::high_resolution_clock::now(); SolverCG cg{cell, cg_tol, maxiter, static_cast(verbose)}; auto res = de_geus(cell, DeltaF, cg, newton_tol, verbose); std::chrono::duration dur = std::chrono::high_resolution_clock::now() - start; std::cout << "Resolution time = " << dur.count() << "s" << std::endl; std::cout << res.grad.transpose() << std::endl; return 0; } diff --git a/bin/demonstrator_dynamic_solve.cc b/bin/demonstrator_dynamic_solve.cc index 79800b8..27de556 100644 --- a/bin/demonstrator_dynamic_solve.cc +++ b/bin/demonstrator_dynamic_solve.cc @@ -1,142 +1,142 @@ /** * @file demonstrator1.cc * * @author Till Junge * * @date 03 Jan 2018 * * @brief larger problem to show off * * Copyright © 2018 Till Junge * * µSpectre 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, 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 Lesser General Public License * along with µSpectre; see the file COPYING. If not, write to the * Free Software Foundation, Inc., 59 Temple Place - Suite 330, * * Boston, MA 02111-1307, USA. * * Additional permission under GNU GPL version 3 section 7 * * If you modify this Program, or any covered work, by linking or combining it * with proprietary FFT implementations or numerical libraries, containing parts * covered by the terms of those libraries' licenses, the licensors of this * Program grant you additional permission to convey the resulting work. */ #include #include #include #include "external/cxxopts.hpp" #include "common/common.hh" #include "common/ccoord_operations.hh" #include "cell/cell_factory.hh" #include "materials/material_linear_elastic1.hh" #include "solver/solvers.hh" #include "solver/solver_cg.hh" using opt_ptr = std::unique_ptr; -opt_ptr parse_args(int argc, char **argv) { +opt_ptr parse_args(int argc, char ** argv) { opt_ptr options = std::make_unique(argv[0], "Tests MPI fft scalability"); try { options->add_options()("0,N0", "number of rows", cxxopts::value(), "N0")("h,help", "print help")( "positional", "Positional arguments: these are the arguments that are entered " "without an option", cxxopts::value>()); options->parse_positional(std::vector{"N0", "positional"}); options->parse(argc, argv); if (options->count("help")) { std::cout << options->help({"", "Group"}) << std::endl; exit(0); } if (options->count("N0") != 1) { throw cxxopts::OptionException("Parameter N0 missing"); } else if ((*options)["N0"].as() % 2 != 1) { throw cxxopts::OptionException("N0 must be odd"); } else if (options->count("positional") > 0) { throw cxxopts::OptionException("There are too many positional arguments"); } - } catch (const cxxopts::OptionException &e) { + } catch (const cxxopts::OptionException & e) { std::cout << "Error parsing options: " << e.what() << std::endl; exit(1); } return options; } using namespace muSpectre; -int main(int argc, char *argv[]) { +int main(int argc, char * argv[]) { banner("demonstrator1", 2018, "Till Junge "); auto options{parse_args(argc, argv)}; - auto &opt{*options}; + auto & opt{*options}; const Dim_t size{opt["N0"].as()}; constexpr Real fsize{1.}; constexpr Dim_t dim{3}; const Dim_t nb_dofs{ipow(size, dim) * ipow(dim, 2)}; std::cout << "Number of dofs: " << nb_dofs << std::endl; constexpr Formulation form{Formulation::finite_strain}; const Rcoord_t lengths{CcoordOps::get_cube(fsize)}; const Ccoord_t resolutions{CcoordOps::get_cube(size)}; auto cell{make_cell(resolutions, lengths, form)}; constexpr Real E{1.0030648180242636}; constexpr Real nu{0.29930675909878679}; using Material_t = MaterialLinearElastic1; - auto &Material_soft{Material_t::make(cell, "soft", E, nu)}; - auto &Material_hard{Material_t::make(cell, "hard", 10 * E, nu)}; + auto & Material_soft{Material_t::make(cell, "soft", E, nu)}; + auto & Material_hard{Material_t::make(cell, "hard", 10 * E, nu)}; int counter{0}; - for (const auto &&pixel : cell) { + for (const auto && pixel : cell) { int sum = 0; for (Dim_t i = 0; i < dim; ++i) { sum += pixel[i] * 2 / resolutions[i]; } if (sum == 0) { Material_hard.add_pixel(pixel); counter++; } else { Material_soft.add_pixel(pixel); } } std::cout << counter << " Pixel out of " << cell.size() << " are in the hard material" << std::endl; cell.initialise(FFT_PlanFlags::measure); constexpr Real newton_tol{1e-4}; constexpr Real cg_tol{1e-7}; const Uint maxiter = nb_dofs; Eigen::MatrixXd DeltaF{Eigen::MatrixXd::Zero(dim, dim)}; DeltaF(0, 1) = .1; Dim_t verbose{1}; auto start = std::chrono::high_resolution_clock::now(); LoadSteps_t loads{DeltaF}; SolverCG cg{cell, cg_tol, maxiter, static_cast(verbose)}; newton_cg(cell, loads, cg, newton_tol, verbose); std::chrono::duration dur = std::chrono::high_resolution_clock::now() - start; std::cout << "Resolution time = " << dur.count() << "s" << std::endl; return 0; } diff --git a/bin/demonstrator_mpi.cc b/bin/demonstrator_mpi.cc index f7c0b99..1cbf1c1 100644 --- a/bin/demonstrator_mpi.cc +++ b/bin/demonstrator_mpi.cc @@ -1,156 +1,156 @@ /** * file demonstrator_mpi.cc * * @author Till Junge * * @date 04 Apr 2018 * * @brief MPI parallel demonstration problem * * @section LICENSE * * Copyright © 2018 Till Junge * * µSpectre 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, 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 Lesser General Public License * along with µSpectre; see the file COPYING. If not, write to the * Free Software Foundation, Inc., 59 Temple Place - Suite 330, * * Boston, MA 02111-1307, USA. * * Additional permission under GNU GPL version 3 section 7 * * If you modify this Program, or any covered work, by linking or combining it * with proprietary FFT implementations or numerical libraries, containing parts * covered by the terms of those libraries' licenses, the licensors of this * Program grant you additional permission to convey the resulting work. */ #include #include #include #include "external/cxxopts.hpp" #include "common/common.hh" #include "common/ccoord_operations.hh" #include "cell/cell_factory.hh" #include "materials/material_linear_elastic1.hh" #include "solver/solvers.hh" #include "solver/solver_cg.hh" using opt_ptr = std::unique_ptr; -opt_ptr parse_args(int argc, char **argv) { +opt_ptr parse_args(int argc, char ** argv) { opt_ptr options = std::make_unique(argv[0], "Tests MPI fft scalability"); try { options->add_options()("0,N0", "number of rows", cxxopts::value(), "N0")("h,help", "print help")( "positional", "Positional arguments: these are the arguments that are entered " "without an option", cxxopts::value>()); options->parse_positional(std::vector{"N0", "positional"}); options->parse(argc, argv); if (options->count("help")) { std::cout << options->help({"", "Group"}) << std::endl; exit(0); } if (options->count("N0") != 1) { throw cxxopts::OptionException("Parameter N0 missing"); } else if ((*options)["N0"].as() % 2 != 1) { throw cxxopts::OptionException("N0 must be odd"); } else if (options->count("positional") > 0) { throw cxxopts::OptionException("There are too many positional arguments"); } - } catch (const cxxopts::OptionException &e) { + } catch (const cxxopts::OptionException & e) { std::cout << "Error parsing options: " << e.what() << std::endl; exit(1); } return options; } using namespace muSpectre; -int main(int argc, char *argv[]) { +int main(int argc, char * argv[]) { banner("demonstrator mpi", 2018, "Till Junge "); auto options{parse_args(argc, argv)}; - auto &opt{*options}; + auto & opt{*options}; const Dim_t size{opt["N0"].as()}; constexpr Real fsize{1.}; constexpr Dim_t dim{3}; const Dim_t nb_dofs{ipow(size, dim) * ipow(dim, 2)}; std::cout << "Number of dofs: " << nb_dofs << std::endl; constexpr Formulation form{Formulation::finite_strain}; const Rcoord_t lengths{CcoordOps::get_cube(fsize)}; const Ccoord_t resolutions{CcoordOps::get_cube(size)}; { Communicator comm{MPI_COMM_WORLD}; MPI_Init(&argc, &argv); auto cell{make_parallel_cell(resolutions, lengths, form, comm)}; constexpr Real E{1.0030648180242636}; constexpr Real nu{0.29930675909878679}; using Material_t = MaterialLinearElastic1; auto Material_soft{std::make_unique("soft", E, nu)}; auto Material_hard{std::make_unique("hard", 10 * E, nu)}; int counter{0}; - for (const auto &&pixel : cell) { + for (const auto && pixel : cell) { int sum = 0; for (Dim_t i = 0; i < dim; ++i) { sum += pixel[i] * 2 / resolutions[i]; } if (sum == 0) { Material_hard->add_pixel(pixel); counter++; } else { Material_soft->add_pixel(pixel); } } if (comm.rank() == 0) { std::cout << counter << " Pixel out of " << cell.size() << " are in the hard material" << std::endl; } cell.add_material(std::move(Material_soft)); cell.add_material(std::move(Material_hard)); cell.initialise(FFT_PlanFlags::measure); constexpr Real newton_tol{1e-4}; constexpr Real cg_tol{1e-7}; const Uint maxiter = nb_dofs; Eigen::MatrixXd DeltaF{Eigen::MatrixXd::Zero(dim, dim)}; DeltaF(0, 1) = .1; Dim_t verbose{1}; auto start = std::chrono::high_resolution_clock::now(); LoadSteps_t grads{DeltaF}; SolverCG cg{cell, cg_tol, maxiter, static_cast(verbose)}; de_geus(cell, grads, cg, newton_tol, verbose); std::chrono::duration dur = std::chrono::high_resolution_clock::now() - start; if (comm.rank() == 0) { std::cout << "Resolution time = " << dur.count() << "s" << std::endl; } MPI_Barrier(comm.get_mpi_comm()); } MPI_Finalize(); return 0; } diff --git a/bin/hyper-elasticity.cc b/bin/hyper-elasticity.cc index d2aebec..005f41a 100644 --- a/bin/hyper-elasticity.cc +++ b/bin/hyper-elasticity.cc @@ -1,91 +1,91 @@ /** * @file hyper-elasticity.cc * * @author Till Junge * * @date 16 Jan 2018 * * @brief Recreation of GooseFFT's hyper-elasticity.py calculation * * Copyright © 2018 Till Junge * * µSpectre 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, 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 Lesser General Public License * along with µSpectre; see the file COPYING. If not, write to the * Free Software Foundation, Inc., 59 Temple Place - Suite 330, * * Boston, MA 02111-1307, USA. * * Additional permission under GNU GPL version 3 section 7 * * If you modify this Program, or any covered work, by linking or combining it * with proprietary FFT implementations or numerical libraries, containing parts * covered by the terms of those libraries' licenses, the licensors of this * Program grant you additional permission to convey the resulting work. */ #include "cell/cell_factory.hh" #include "materials/material_linear_elastic1.hh" #include "solver/solvers.hh" #include "solver/solver_cg.hh" #include #include using namespace muSpectre; int main() { constexpr Dim_t dim{3}; constexpr Ccoord_t N{CcoordOps::get_cube(11)}; constexpr Rcoord_t lens{CcoordOps::get_cube(1.)}; constexpr Dim_t incl_size{3}; auto cell{make_cell(N, lens, Formulation::small_strain)}; // constexpr Real K_hard{8.33}, K_soft{.833}; // constexpr Real mu_hard{3.86}, mu_soft{.386}; // auto E = [](Real K, Real G) {return 9*K*G / (3*K+G);}; //G is mu // auto nu= [](Real K, Real G) {return (3*K-2*G) / (2*(3*K+G));}; // auto & hard{MaterialLinearElastic1::make(cell, "hard", // E(K_hard, mu_hard), // nu(K_hard, mu_hard))}; // auto & soft{MaterialLinearElastic1::make(cell, "soft", // E(K_soft, mu_soft), // nu(K_soft, mu_soft))}; Real ex{1e-5}; using Mat_t = MaterialLinearElastic1; - auto &hard{Mat_t::make(cell, "hard", 210. * ex, .33)}; - auto &soft{Mat_t::make(cell, "soft", 70. * ex, .33)}; + auto & hard{Mat_t::make(cell, "hard", 210. * ex, .33)}; + auto & soft{Mat_t::make(cell, "soft", 70. * ex, .33)}; for (auto pixel : cell) { if ((pixel[0] >= N[0] - incl_size) && (pixel[1] < incl_size) && (pixel[2] >= N[2] - incl_size)) { hard.add_pixel(pixel); } else { soft.add_pixel(pixel); } } std::cout << hard.size() << " pixels in the inclusion" << std::endl; cell.initialise(); constexpr Real cg_tol{1e-8}, newton_tol{1e-5}; constexpr Dim_t maxiter{200}; constexpr Dim_t verbose{1}; Eigen::MatrixXd dF_bar{Eigen::MatrixXd::Zero(dim, dim)}; dF_bar(0, 1) = 1.; SolverCG cg{cell, cg_tol, maxiter, verbose}; auto optimize_res = de_geus(cell, dF_bar, cg, newton_tol, verbose); std::cout << "nb_cg: " << optimize_res.nb_fev << std::endl; std::cout << optimize_res.grad.transpose().block(0, 0, 10, 9) << std::endl; return 0; } diff --git a/bin/small_case.cc b/bin/small_case.cc index 1dd6ae9..9b1f57a 100644 --- a/bin/small_case.cc +++ b/bin/small_case.cc @@ -1,83 +1,83 @@ /** * @file small_case.cc * * @author Till Junge * * @date 12 Jan 2018 * * @brief small case for debugging * * Copyright © 2018 Till Junge * * µSpectre 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, 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 Lesser General Public License * along with µSpectre; see the file COPYING. If not, write to the * Free Software Foundation, Inc., 59 Temple Place - Suite 330, * * Boston, MA 02111-1307, USA. * * Additional permission under GNU GPL version 3 section 7 * * If you modify this Program, or any covered work, by linking or combining it * with proprietary FFT implementations or numerical libraries, containing parts * covered by the terms of those libraries' licenses, the licensors of this * Program grant you additional permission to convey the resulting work. */ #include "common/common.hh" #include "common/iterators.hh" #include "cell/cell_factory.hh" #include "materials/material_linear_elastic1.hh" #include "solver/solvers.hh" #include "solver/solver_cg.hh" #include using namespace muSpectre; int main() { constexpr Dim_t dim{twoD}; Ccoord_t resolution{11, 11}; Rcoord_t lengths{ CcoordOps::get_cube(11.)}; // {5.2e-9, 8.3e-9, 8.3e-9}; Formulation form{Formulation::finite_strain}; auto rve{make_cell(resolution, lengths, form)}; - auto &hard{MaterialLinearElastic1::make(rve, "hard", 210., .33)}; - auto &soft{MaterialLinearElastic1::make(rve, "soft", 70., .33)}; + auto & hard{MaterialLinearElastic1::make(rve, "hard", 210., .33)}; + auto & soft{MaterialLinearElastic1::make(rve, "soft", 70., .33)}; - for (auto &&tup : akantu::enumerate(rve)) { - auto &i = std::get<0>(tup); - auto &pixel = std::get<1>(tup); + for (auto && tup : akantu::enumerate(rve)) { + auto & i = std::get<0>(tup); + auto & pixel = std::get<1>(tup); if (i < 3) { hard.add_pixel(pixel); } else { soft.add_pixel(pixel); } } rve.initialise(); Real tol{1e-6}; Eigen::MatrixXd Del0{}; Del0 << 0, .1, 0, 0; Uint maxiter{31}; Dim_t verbose{3}; SolverCG cg{rve, tol, maxiter, static_cast(verbose)}; auto res = de_geus(rve, Del0, cg, tol, verbose); std::cout << res.grad.transpose() << std::endl; return 0; } diff --git a/cmake/cpplint.cmake b/cmake/cpplint.cmake index d15cf4e..1ad9dae 100644 --- a/cmake/cpplint.cmake +++ b/cmake/cpplint.cmake @@ -1,105 +1,105 @@ # # CMake module to C++ static analysis against # Google C++ Style Guide (https://google.github.io/styleguide/cppguide.html) # # For more detials please follow links: # # - https://github.com/google/styleguide # - https://pypi.python.org/pypi/cpplint # - https://github.com/theandrewdavis/cpplint # # Copyright (c) 2016 Piotr L. Figlarek # Copyright on modifications © 2018 Till Junge # # Usage # ----- # Include this module via CMake include(...) command and then add each source directory # via introduced by this module cpplint_add_subdirectory(...) function. Added directory # will be recursivelly scanned and all available files will be checked. # # Example # ------- # # include CMake module # include(cmake/cpplint.cmake) # # # add all source code directories # cpplint_add_subdirectory(core) # cpplint_add_subdirectory(modules/c-bind) # # License (MIT) # ------------- # Permission is hereby granted, free of charge, to any person obtaining a copy # of this software and associated documentation files (the "Software"), to deal # in the Software without restriction, including without limitation the rights # to use, copy, modify, merge, publish, distribute, sublicense, and/or sell # copies of the Software, and to permit persons to whom the Software is # furnished to do so, subject to the following conditions: # # The above copyright notice and this permission notice shall be included in all # copies or substantial portions of the Software. # # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE # AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE # SOFTWARE. # select files extensions to check # target to run cpplint.py for all configured sources set(CPPLINT_TARGET lint CACHE STRING "Name of C++ style checker target") # project root directory set(CPPLINT_PROJECT_ROOT ${PROJECT_SOURCE_DIR} CACHE STRING "Project ROOT directory") # find cpplint.py script -find_file(CPPLINT name cpplint HINTS $ENV{HOME}.local/bin) +find_file(CPPLINT name "cpplint.py" PATHS ${PROJECT_SOURCE_DIR}/external) if(CPPLINT) message(STATUS "cpplint parser: ${CPPLINT}") else() message(FATAL_ERROR "cpplint script: NOT FOUND! " "Please install cpplint as described on https://pypi.python.org/pypi/cpplint. " "In most cases command 'sudo pip install cpplint' should be sufficent.") endif() # common target to concatenate all cpplint.py targets add_custom_target(${CPPLINT_TARGET}) # use cpplint.py to check source code files inside DIR directory function(cpplint_add_subdirectory DIR FLAGS) # create relative path to the directory set(ABSOLUTE_DIR ${DIR}) set(EXTENSIONS cc,hh) set(FILES_TO_CHECK ${FILES_TO_CHECK} ${ABSOLUTE_DIR}/*.cc ${ABSOLUTE_DIR}/*.hh) # find all source files inside project file(GLOB_RECURSE LIST_OF_FILES ${FILES_TO_CHECK}) # create valid target name for this check get_filename_component(DNAME ${DIR} NAME) string(REGEX REPLACE "/" "." TEST_NAME ${DNAME}) set(TARGET_NAME ${CPPLINT_TARGET}.${TEST_NAME}) # perform cpplint check add_custom_target(${TARGET_NAME} - COMMAND ${CPPLINT} "--extensions=${EXTENSIONS}" - "--root=${CPPLINT_PROJECT_ROOT}" - "${FLAGS}" - ${LIST_OF_FILES} - DEPENDS ${LIST_OF_FILES} - COMMENT "cpplint: Checking source code style" - ) + COMMAND ${CPPLINT} "--extensions=${EXTENSIONS}" + "--root=${CPPLINT_PROJECT_ROOT}" + "${FLAGS}" + ${LIST_OF_FILES} + DEPENDS ${LIST_OF_FILES} + COMMENT "cpplint: Checking source code style" + ) # run this target when root cpplint.py test is triggered add_dependencies(${CPPLINT_TARGET} ${TARGET_NAME}) # add this test to CTest add_test(${TARGET_NAME} ${CMAKE_MAKE_PROGRAM} ${TARGET_NAME}) endfunction() diff --git a/external/cpplint.py b/external/cpplint.py new file mode 100755 index 0000000..fb550b5 --- /dev/null +++ b/external/cpplint.py @@ -0,0 +1,6470 @@ +#!/usr/bin/env python3 +# +# Copyright (c) 2009 Google Inc. All rights reserved. +# +# Redistribution and use in source and binary forms, with or without +# modification, are permitted provided that the following conditions are +# met: +# +# * Redistributions of source code must retain the above copyright +# notice, this list of conditions and the following disclaimer. +# * Redistributions in binary form must reproduce the above +# copyright notice, this list of conditions and the following disclaimer +# in the documentation and/or other materials provided with the +# distribution. +# * Neither the name of Google Inc. nor the names of its +# contributors may be used to endorse or promote products derived from +# this software without specific prior written permission. +# +# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS +# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT +# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR +# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT +# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, +# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT +# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +# +# Modified by Till Junge to handle boolean operators "and" +# and "or" correctly + +"""Does google-lint on c++ files. + +The goal of this script is to identify places in the code that *may* +be in non-compliance with google style. It does not attempt to fix +up these problems -- the point is to educate. It does also not +attempt to find all problems, or to ensure that everything it does +find is legitimately a problem. + +In particular, we can get very confused by /* and // inside strings! +We do a small hack, which is to ignore //'s with "'s after them on the +same line, but it is far from perfect (in either direction). +""" + +import codecs +import copy +import getopt +import glob +import itertools +import math # for log +import os +import re +import sre_compile +import string +import sys +import unicodedata +import xml.etree.ElementTree + +# if empty, use defaults +_header_extensions = set([]) + +# if empty, use defaults +_valid_extensions = set([]) + + +# Files with any of these extensions are considered to be +# header files (and will undergo different style checks). +# This set can be extended by using the --headers +# option (also supported in CPPLINT.cfg) +def GetHeaderExtensions(): + if not _header_extensions: + return set(['h', 'hpp', 'hxx', 'h++', 'cuh']) + return _header_extensions + +# The allowed extensions for file names +# This is set by --extensions flag +def GetAllExtensions(): + if not _valid_extensions: + return GetHeaderExtensions().union(set(['c', 'cc', 'cpp', 'cxx', 'c++', 'cu'])) + return _valid_extensions + +def GetNonHeaderExtensions(): + return GetAllExtensions().difference(GetHeaderExtensions()) + + +_USAGE = """ +Syntax: cpplint.py [--verbose=#] [--output=emacs|eclipse|vs7|junit] + [--filter=-x,+y,...] + [--counting=total|toplevel|detailed] [--repository=path] + [--root=subdir] [--linelength=digits] [--recursive] + [--exclude=path] + [--headers=ext1,ext2] + [--extensions=hpp,cpp,...] + [file] ... + + The style guidelines this tries to follow are those in + https://google.github.io/styleguide/cppguide.html + + Every problem is given a confidence score from 1-5, with 5 meaning we are + certain of the problem, and 1 meaning it could be a legitimate construct. + This will miss some errors, and is not a substitute for a code review. + + To suppress false-positive errors of a certain category, add a + 'NOLINT(category)' comment to the line. NOLINT or NOLINT(*) + suppresses errors of all categories on that line. + + The files passed in will be linted; at least one file must be provided. + Default linted extensions are %s. + Other file types will be ignored. + Change the extensions with the --extensions flag. + + Flags: + + output=emacs|eclipse|vs7|junit + By default, the output is formatted to ease emacs parsing. Output + compatible with eclipse (eclipse), Visual Studio (vs7), and JUnit + XML parsers such as those used in Jenkins and Bamboo may also be + used. Other formats are unsupported. + + verbose=# + Specify a number 0-5 to restrict errors to certain verbosity levels. + Errors with lower verbosity levels have lower confidence and are more + likely to be false positives. + + quiet + Supress output other than linting errors, such as information about + which files have been processed and excluded. + + filter=-x,+y,... + Specify a comma-separated list of category-filters to apply: only + error messages whose category names pass the filters will be printed. + (Category names are printed with the message and look like + "[whitespace/indent]".) Filters are evaluated left to right. + "-FOO" and "FOO" means "do not print categories that start with FOO". + "+FOO" means "do print categories that start with FOO". + + Examples: --filter=-whitespace,+whitespace/braces + --filter=whitespace,runtime/printf,+runtime/printf_format + --filter=-,+build/include_what_you_use + + To see a list of all the categories used in cpplint, pass no arg: + --filter= + + counting=total|toplevel|detailed + The total number of errors found is always printed. If + 'toplevel' is provided, then the count of errors in each of + the top-level categories like 'build' and 'whitespace' will + also be printed. If 'detailed' is provided, then a count + is provided for each category like 'build/class'. + + repository=path + The top level directory of the repository, used to derive the header + guard CPP variable. By default, this is determined by searching for a + path that contains .git, .hg, or .svn. When this flag is specified, the + given path is used instead. This option allows the header guard CPP + variable to remain consistent even if members of a team have different + repository root directories (such as when checking out a subdirectory + with SVN). In addition, users of non-mainstream version control systems + can use this flag to ensure readable header guard CPP variables. + + Examples: + Assuming that Alice checks out ProjectName and Bob checks out + ProjectName/trunk and trunk contains src/chrome/ui/browser.h, then + with no --repository flag, the header guard CPP variable will be: + + Alice => TRUNK_SRC_CHROME_BROWSER_UI_BROWSER_H_ + Bob => SRC_CHROME_BROWSER_UI_BROWSER_H_ + + If Alice uses the --repository=trunk flag and Bob omits the flag or + uses --repository=. then the header guard CPP variable will be: + + Alice => SRC_CHROME_BROWSER_UI_BROWSER_H_ + Bob => SRC_CHROME_BROWSER_UI_BROWSER_H_ + + root=subdir + The root directory used for deriving header guard CPP variables. This + directory is relative to the top level directory of the repository which + by default is determined by searching for a directory that contains .git, + .hg, or .svn but can also be controlled with the --repository flag. If + the specified directory does not exist, this flag is ignored. + + Examples: + Assuming that src is the top level directory of the repository, the + header guard CPP variables for src/chrome/browser/ui/browser.h are: + + No flag => CHROME_BROWSER_UI_BROWSER_H_ + --root=chrome => BROWSER_UI_BROWSER_H_ + --root=chrome/browser => UI_BROWSER_H_ + + linelength=digits + This is the allowed line length for the project. The default value is + 80 characters. + + Examples: + --linelength=120 + + recursive + Search for files to lint recursively. Each directory given in the list + of files to be linted is replaced by all files that descend from that + directory. Files with extensions not in the valid extensions list are + excluded. + + exclude=path + Exclude the given path from the list of files to be linted. Relative + paths are evaluated relative to the current directory and shell globbing + is performed. This flag can be provided multiple times to exclude + multiple files. + + Examples: + --exclude=one.cc + --exclude=src/*.cc + --exclude=src/*.cc --exclude=test/*.cc + + extensions=extension,extension,... + The allowed file extensions that cpplint will check + + Examples: + --extensions=%s + + headers=extension,extension,... + The allowed header extensions that cpplint will consider to be header files + (by default, only files with extensions %s + will be assumed to be headers) + + Examples: + --headers=%s + + cpplint.py supports per-directory configurations specified in CPPLINT.cfg + files. CPPLINT.cfg file can contain a number of key=value pairs. + Currently the following options are supported: + + set noparent + filter=+filter1,-filter2,... + exclude_files=regex + linelength=80 + root=subdir + + "set noparent" option prevents cpplint from traversing directory tree + upwards looking for more .cfg files in parent directories. This option + is usually placed in the top-level project directory. + + The "filter" option is similar in function to --filter flag. It specifies + message filters in addition to the |_DEFAULT_FILTERS| and those specified + through --filter command-line flag. + + "exclude_files" allows to specify a regular expression to be matched against + a file name. If the expression matches, the file is skipped and not run + through the linter. + + "linelength" specifies the allowed line length for the project. + + The "root" option is similar in function to the --root flag (see example + above). + + CPPLINT.cfg has an effect on files in the same directory and all + subdirectories, unless overridden by a nested configuration file. + + Example file: + filter=-build/include_order,+build/include_alpha + exclude_files=.*\\.cc + + The above example disables build/include_order warning and enables + build/include_alpha as well as excludes all .cc from being + processed by linter, in the current directory (where the .cfg + file is located) and all subdirectories. +""" % (list(GetAllExtensions()), + ','.join(list(GetAllExtensions())), + GetHeaderExtensions(), + ','.join(GetHeaderExtensions())) + +# We categorize each error message we print. Here are the categories. +# We want an explicit list so we can list them all in cpplint --filter=. +# If you add a new error message with a new category, add it to the list +# here! cpplint_unittest.py should tell you if you forget to do this. +_ERROR_CATEGORIES = [ + 'build/class', + 'build/c++11', + 'build/c++14', + 'build/c++tr1', + 'build/deprecated', + 'build/endif_comment', + 'build/explicit_make_pair', + 'build/forward_decl', + 'build/header_guard', + 'build/include', + 'build/include_subdir', + 'build/include_alpha', + 'build/include_order', + 'build/include_what_you_use', + 'build/namespaces_literals', + 'build/namespaces', + 'build/printf_format', + 'build/storage_class', + 'legal/copyright', + 'readability/alt_tokens', + 'readability/braces', + 'readability/casting', + 'readability/check', + 'readability/constructors', + 'readability/fn_size', + 'readability/inheritance', + 'readability/multiline_comment', + 'readability/multiline_string', + 'readability/namespace', + 'readability/nolint', + 'readability/nul', + 'readability/strings', + 'readability/todo', + 'readability/utf8', + 'runtime/arrays', + 'runtime/casting', + 'runtime/explicit', + 'runtime/int', + 'runtime/init', + 'runtime/invalid_increment', + 'runtime/member_string_references', + 'runtime/memset', + 'runtime/indentation_namespace', + 'runtime/operator', + 'runtime/printf', + 'runtime/printf_format', + 'runtime/references', + 'runtime/string', + 'runtime/threadsafe_fn', + 'runtime/vlog', + 'whitespace/blank_line', + 'whitespace/braces', + 'whitespace/comma', + 'whitespace/comments', + 'whitespace/empty_conditional_body', + 'whitespace/empty_if_body', + 'whitespace/empty_loop_body', + 'whitespace/end_of_line', + 'whitespace/ending_newline', + 'whitespace/forcolon', + 'whitespace/indent', + 'whitespace/line_length', + 'whitespace/newline', + 'whitespace/operators', + 'whitespace/parens', + 'whitespace/semicolon', + 'whitespace/tab', + 'whitespace/todo', + ] + +# These error categories are no longer enforced by cpplint, but for backwards- +# compatibility they may still appear in NOLINT comments. +_LEGACY_ERROR_CATEGORIES = [ + 'readability/streams', + 'readability/function', + ] + +# The default state of the category filter. This is overridden by the --filter= +# flag. By default all errors are on, so only add here categories that should be +# off by default (i.e., categories that must be enabled by the --filter= flags). +# All entries here should start with a '-' or '+', as in the --filter= flag. +_DEFAULT_FILTERS = ['-build/include_alpha'] + +# The default list of categories suppressed for C (not C++) files. +_DEFAULT_C_SUPPRESSED_CATEGORIES = [ + 'readability/casting', + ] + +# The default list of categories suppressed for Linux Kernel files. +_DEFAULT_KERNEL_SUPPRESSED_CATEGORIES = [ + 'whitespace/tab', + ] + +# We used to check for high-bit characters, but after much discussion we +# decided those were OK, as long as they were in UTF-8 and didn't represent +# hard-coded international strings, which belong in a separate i18n file. + +# C++ headers +_CPP_HEADERS = frozenset([ + # Legacy + 'algobase.h', + 'algo.h', + 'alloc.h', + 'builtinbuf.h', + 'bvector.h', + 'complex.h', + 'defalloc.h', + 'deque.h', + 'editbuf.h', + 'fstream.h', + 'function.h', + 'hash_map', + 'hash_map.h', + 'hash_set', + 'hash_set.h', + 'hashtable.h', + 'heap.h', + 'indstream.h', + 'iomanip.h', + 'iostream.h', + 'istream.h', + 'iterator.h', + 'list.h', + 'map.h', + 'multimap.h', + 'multiset.h', + 'ostream.h', + 'pair.h', + 'parsestream.h', + 'pfstream.h', + 'procbuf.h', + 'pthread_alloc', + 'pthread_alloc.h', + 'rope', + 'rope.h', + 'ropeimpl.h', + 'set.h', + 'slist', + 'slist.h', + 'stack.h', + 'stdiostream.h', + 'stl_alloc.h', + 'stl_relops.h', + 'streambuf.h', + 'stream.h', + 'strfile.h', + 'strstream.h', + 'tempbuf.h', + 'tree.h', + 'type_traits.h', + 'vector.h', + # 17.6.1.2 C++ library headers + 'algorithm', + 'array', + 'atomic', + 'bitset', + 'chrono', + 'codecvt', + 'complex', + 'condition_variable', + 'deque', + 'exception', + 'forward_list', + 'fstream', + 'functional', + 'future', + 'initializer_list', + 'iomanip', + 'ios', + 'iosfwd', + 'iostream', + 'istream', + 'iterator', + 'limits', + 'list', + 'locale', + 'map', + 'memory', + 'mutex', + 'new', + 'numeric', + 'ostream', + 'queue', + 'random', + 'ratio', + 'regex', + 'scoped_allocator', + 'set', + 'sstream', + 'stack', + 'stdexcept', + 'streambuf', + 'string', + 'strstream', + 'system_error', + 'thread', + 'tuple', + 'typeindex', + 'typeinfo', + 'type_traits', + 'unordered_map', + 'unordered_set', + 'utility', + 'valarray', + 'vector', + # 17.6.1.2 C++ headers for C library facilities + 'cassert', + 'ccomplex', + 'cctype', + 'cerrno', + 'cfenv', + 'cfloat', + 'cinttypes', + 'ciso646', + 'climits', + 'clocale', + 'cmath', + 'csetjmp', + 'csignal', + 'cstdalign', + 'cstdarg', + 'cstdbool', + 'cstddef', + 'cstdint', + 'cstdio', + 'cstdlib', + 'cstring', + 'ctgmath', + 'ctime', + 'cuchar', + 'cwchar', + 'cwctype', + ]) + +# Type names +_TYPES = re.compile( + r'^(?:' + # [dcl.type.simple] + r'(char(16_t|32_t)?)|wchar_t|' + r'bool|short|int|long|signed|unsigned|float|double|' + # [support.types] + r'(ptrdiff_t|size_t|max_align_t|nullptr_t)|' + # [cstdint.syn] + r'(u?int(_fast|_least)?(8|16|32|64)_t)|' + r'(u?int(max|ptr)_t)|' + r')$') + + +# These headers are excluded from [build/include] and [build/include_order] +# checks: +# - Anything not following google file name conventions (containing an +# uppercase character, such as Python.h or nsStringAPI.h, for example). +# - Lua headers. +_THIRD_PARTY_HEADERS_PATTERN = re.compile( + r'^(?:[^/]*[A-Z][^/]*\.h|lua\.h|lauxlib\.h|lualib\.h)$') + +# Pattern for matching FileInfo.BaseName() against test file name +_test_suffixes = ['_test', '_regtest', '_unittest'] +_TEST_FILE_SUFFIX = '(' + '|'.join(_test_suffixes) + r')$' + +# Pattern that matches only complete whitespace, possibly across multiple lines. +_EMPTY_CONDITIONAL_BODY_PATTERN = re.compile(r'^\s*$', re.DOTALL) + +# Assertion macros. These are defined in base/logging.h and +# testing/base/public/gunit.h. +_CHECK_MACROS = [ + 'DCHECK', 'CHECK', + 'EXPECT_TRUE', 'ASSERT_TRUE', + 'EXPECT_FALSE', 'ASSERT_FALSE', + ] + +# Replacement macros for CHECK/DCHECK/EXPECT_TRUE/EXPECT_FALSE +_CHECK_REPLACEMENT = dict([(macro_var, {}) for macro_var in _CHECK_MACROS]) + +for op, replacement in [('==', 'EQ'), ('!=', 'NE'), + ('>=', 'GE'), ('>', 'GT'), + ('<=', 'LE'), ('<', 'LT')]: + _CHECK_REPLACEMENT['DCHECK'][op] = 'DCHECK_%s' % replacement + _CHECK_REPLACEMENT['CHECK'][op] = 'CHECK_%s' % replacement + _CHECK_REPLACEMENT['EXPECT_TRUE'][op] = 'EXPECT_%s' % replacement + _CHECK_REPLACEMENT['ASSERT_TRUE'][op] = 'ASSERT_%s' % replacement + +for op, inv_replacement in [('==', 'NE'), ('!=', 'EQ'), + ('>=', 'LT'), ('>', 'LE'), + ('<=', 'GT'), ('<', 'GE')]: + _CHECK_REPLACEMENT['EXPECT_FALSE'][op] = 'EXPECT_%s' % inv_replacement + _CHECK_REPLACEMENT['ASSERT_FALSE'][op] = 'ASSERT_%s' % inv_replacement + +# Alternative tokens and their replacements. For full list, see section 2.5 +# Alternative tokens [lex.digraph] in the C++ standard. +# +# Digraphs (such as '%:') are not included here since it's a mess to +# match those on a word boundary. +_ALT_TOKEN_REPLACEMENT = { + 'and': '&&', + 'bitor': '|', + 'or': '||', + 'xor': '^', + 'compl': '~', + 'bitand': '&', + 'and_eq': '&=', + 'or_eq': '|=', + 'xor_eq': '^=', + 'not': '!', + 'not_eq': '!=' + } + +# Compile regular expression that matches all the above keywords. The "[ =()]" +# bit is meant to avoid matching these keywords outside of boolean expressions. +# +# False positives include C-style multi-line comments and multi-line strings +# but those have always been troublesome for cpplint. +_ALT_TOKEN_REPLACEMENT_PATTERN = re.compile( + r'[ =()](' + ('|'.join(_ALT_TOKEN_REPLACEMENT.keys())) + r')(?=[ (]|$)') + + +# These constants define types of headers for use with +# _IncludeState.CheckNextIncludeOrder(). +_C_SYS_HEADER = 1 +_CPP_SYS_HEADER = 2 +_LIKELY_MY_HEADER = 3 +_POSSIBLE_MY_HEADER = 4 +_OTHER_HEADER = 5 + +# These constants define the current inline assembly state +_NO_ASM = 0 # Outside of inline assembly block +_INSIDE_ASM = 1 # Inside inline assembly block +_END_ASM = 2 # Last line of inline assembly block +_BLOCK_ASM = 3 # The whole block is an inline assembly block + +# Match start of assembly blocks +_MATCH_ASM = re.compile(r'^\s*(?:asm|_asm|__asm|__asm__)' + r'(?:\s+(volatile|__volatile__))?' + r'\s*[{(]') + +# Match strings that indicate we're working on a C (not C++) file. +_SEARCH_C_FILE = re.compile(r'\b(?:LINT_C_FILE|' + r'vim?:\s*.*(\s*|:)filetype=c(\s*|:|$))') + +# Match string that indicates we're working on a Linux Kernel file. +_SEARCH_KERNEL_FILE = re.compile(r'\b(?:LINT_KERNEL_FILE)') + +_regexp_compile_cache = {} + +# {str, set(int)}: a map from error categories to sets of linenumbers +# on which those errors are expected and should be suppressed. +_error_suppressions = {} + +# The root directory used for deriving header guard CPP variable. +# This is set by --root flag. +_root = None + +# The top level repository directory. If set, _root is calculated relative to +# this directory instead of the directory containing version control artifacts. +# This is set by the --repository flag. +_repository = None + +# Files to exclude from linting. This is set by the --exclude flag. +_excludes = None + +# Whether to supress PrintInfo messages +_quiet = False + +# The allowed line length of files. +# This is set by --linelength flag. +_line_length = 80 + +try: + xrange(1, 0) +except NameError: + # -- pylint: disable=redefined-builtin + xrange = range + +try: + unicode +except NameError: + # -- pylint: disable=redefined-builtin + basestring = unicode = str + +try: + long(2) +except NameError: + # -- pylint: disable=redefined-builtin + long = int + +if sys.version_info < (3,): + # -- pylint: disable=no-member + # BINARY_TYPE = str + itervalues = dict.itervalues + iteritems = dict.iteritems +else: + # BINARY_TYPE = bytes + itervalues = dict.values + iteritems = dict.items + +def unicode_escape_decode(x): + if sys.version_info < (3,): + return codecs.unicode_escape_decode(x)[0] + else: + return x + +# {str, bool}: a map from error categories to booleans which indicate if the +# category should be suppressed for every line. +_global_error_suppressions = {} + + + + +def ParseNolintSuppressions(filename, raw_line, linenum, error): + """Updates the global list of line error-suppressions. + + Parses any NOLINT comments on the current line, updating the global + error_suppressions store. Reports an error if the NOLINT comment + was malformed. + + Args: + filename: str, the name of the input file. + raw_line: str, the line of input text, with comments. + linenum: int, the number of the current line. + error: function, an error handler. + """ + matched = Search(r'\bNOLINT(NEXTLINE)?\b(\([^)]+\))?', raw_line) + if matched: + if matched.group(1): + suppressed_line = linenum + 1 + else: + suppressed_line = linenum + category = matched.group(2) + if category in (None, '(*)'): # => "suppress all" + _error_suppressions.setdefault(None, set()).add(suppressed_line) + else: + if category.startswith('(') and category.endswith(')'): + category = category[1:-1] + if category in _ERROR_CATEGORIES: + _error_suppressions.setdefault(category, set()).add(suppressed_line) + elif category not in _LEGACY_ERROR_CATEGORIES: + error(filename, linenum, 'readability/nolint', 5, + 'Unknown NOLINT error category: %s' % category) + + +def ProcessGlobalSuppresions(lines): + """Updates the list of global error suppressions. + + Parses any lint directives in the file that have global effect. + + Args: + lines: An array of strings, each representing a line of the file, with the + last element being empty if the file is terminated with a newline. + """ + for line in lines: + if _SEARCH_C_FILE.search(line): + for category in _DEFAULT_C_SUPPRESSED_CATEGORIES: + _global_error_suppressions[category] = True + if _SEARCH_KERNEL_FILE.search(line): + for category in _DEFAULT_KERNEL_SUPPRESSED_CATEGORIES: + _global_error_suppressions[category] = True + + +def ResetNolintSuppressions(): + """Resets the set of NOLINT suppressions to empty.""" + _error_suppressions.clear() + _global_error_suppressions.clear() + + +def IsErrorSuppressedByNolint(category, linenum): + """Returns true if the specified error category is suppressed on this line. + + Consults the global error_suppressions map populated by + ParseNolintSuppressions/ProcessGlobalSuppresions/ResetNolintSuppressions. + + Args: + category: str, the category of the error. + linenum: int, the current line number. + Returns: + bool, True iff the error should be suppressed due to a NOLINT comment or + global suppression. + """ + return (_global_error_suppressions.get(category, False) or + linenum in _error_suppressions.get(category, set()) or + linenum in _error_suppressions.get(None, set())) + + +def Match(pattern, s): + """Matches the string with the pattern, caching the compiled regexp.""" + # The regexp compilation caching is inlined in both Match and Search for + # performance reasons; factoring it out into a separate function turns out + # to be noticeably expensive. + if pattern not in _regexp_compile_cache: + _regexp_compile_cache[pattern] = sre_compile.compile(pattern) + return _regexp_compile_cache[pattern].match(s) + + +def ReplaceAll(pattern, rep, s): + """Replaces instances of pattern in a string with a replacement. + + The compiled regex is kept in a cache shared by Match and Search. + + Args: + pattern: regex pattern + rep: replacement text + s: search string + + Returns: + string with replacements made (or original string if no replacements) + """ + if pattern not in _regexp_compile_cache: + _regexp_compile_cache[pattern] = sre_compile.compile(pattern) + return _regexp_compile_cache[pattern].sub(rep, s) + + +def Search(pattern, s): + """Searches the string for the pattern, caching the compiled regexp.""" + if pattern not in _regexp_compile_cache: + _regexp_compile_cache[pattern] = sre_compile.compile(pattern) + return _regexp_compile_cache[pattern].search(s) + + +def _IsSourceExtension(s): + """File extension (excluding dot) matches a source file extension.""" + return s in GetNonHeaderExtensions() + + +class _IncludeState(object): + """Tracks line numbers for includes, and the order in which includes appear. + + include_list contains list of lists of (header, line number) pairs. + It's a lists of lists rather than just one flat list to make it + easier to update across preprocessor boundaries. + + Call CheckNextIncludeOrder() once for each header in the file, passing + in the type constants defined above. Calls in an illegal order will + raise an _IncludeError with an appropriate error message. + + """ + # self._section will move monotonically through this set. If it ever + # needs to move backwards, CheckNextIncludeOrder will raise an error. + _INITIAL_SECTION = 0 + _MY_H_SECTION = 1 + _C_SECTION = 2 + _CPP_SECTION = 3 + _OTHER_H_SECTION = 4 + + _TYPE_NAMES = { + _C_SYS_HEADER: 'C system header', + _CPP_SYS_HEADER: 'C++ system header', + _LIKELY_MY_HEADER: 'header this file implements', + _POSSIBLE_MY_HEADER: 'header this file may implement', + _OTHER_HEADER: 'other header', + } + _SECTION_NAMES = { + _INITIAL_SECTION: "... nothing. (This can't be an error.)", + _MY_H_SECTION: 'a header this file implements', + _C_SECTION: 'C system header', + _CPP_SECTION: 'C++ system header', + _OTHER_H_SECTION: 'other header', + } + + def __init__(self): + self.include_list = [[]] + self._section = None + self._last_header = None + self.ResetSection('') + + def FindHeader(self, header): + """Check if a header has already been included. + + Args: + header: header to check. + Returns: + Line number of previous occurrence, or -1 if the header has not + been seen before. + """ + for section_list in self.include_list: + for f in section_list: + if f[0] == header: + return f[1] + return -1 + + def ResetSection(self, directive): + """Reset section checking for preprocessor directive. + + Args: + directive: preprocessor directive (e.g. "if", "else"). + """ + # The name of the current section. + self._section = self._INITIAL_SECTION + # The path of last found header. + self._last_header = '' + + # Update list of includes. Note that we never pop from the + # include list. + if directive in ('if', 'ifdef', 'ifndef'): + self.include_list.append([]) + elif directive in ('else', 'elif'): + self.include_list[-1] = [] + + def SetLastHeader(self, header_path): + self._last_header = header_path + + def CanonicalizeAlphabeticalOrder(self, header_path): + """Returns a path canonicalized for alphabetical comparison. + + - replaces "-" with "_" so they both cmp the same. + - removes '-inl' since we don't require them to be after the main header. + - lowercase everything, just in case. + + Args: + header_path: Path to be canonicalized. + + Returns: + Canonicalized path. + """ + return header_path.replace('-inl.h', '.h').replace('-', '_').lower() + + def IsInAlphabeticalOrder(self, clean_lines, linenum, header_path): + """Check if a header is in alphabetical order with the previous header. + + Args: + clean_lines: A CleansedLines instance containing the file. + linenum: The number of the line to check. + header_path: Canonicalized header to be checked. + + Returns: + Returns true if the header is in alphabetical order. + """ + # If previous section is different from current section, _last_header will + # be reset to empty string, so it's always less than current header. + # + # If previous line was a blank line, assume that the headers are + # intentionally sorted the way they are. + if (self._last_header > header_path and + Match(r'^\s*#\s*include\b', clean_lines.elided[linenum - 1])): + return False + return True + + def CheckNextIncludeOrder(self, header_type): + """Returns a non-empty error message if the next header is out of order. + + This function also updates the internal state to be ready to check + the next include. + + Args: + header_type: One of the _XXX_HEADER constants defined above. + + Returns: + The empty string if the header is in the right order, or an + error message describing what's wrong. + + """ + error_message = ('Found %s after %s' % + (self._TYPE_NAMES[header_type], + self._SECTION_NAMES[self._section])) + + last_section = self._section + + if header_type == _C_SYS_HEADER: + if self._section <= self._C_SECTION: + self._section = self._C_SECTION + else: + self._last_header = '' + return error_message + elif header_type == _CPP_SYS_HEADER: + if self._section <= self._CPP_SECTION: + self._section = self._CPP_SECTION + else: + self._last_header = '' + return error_message + elif header_type == _LIKELY_MY_HEADER: + if self._section <= self._MY_H_SECTION: + self._section = self._MY_H_SECTION + else: + self._section = self._OTHER_H_SECTION + elif header_type == _POSSIBLE_MY_HEADER: + if self._section <= self._MY_H_SECTION: + self._section = self._MY_H_SECTION + else: + # This will always be the fallback because we're not sure + # enough that the header is associated with this file. + self._section = self._OTHER_H_SECTION + else: + assert header_type == _OTHER_HEADER + self._section = self._OTHER_H_SECTION + + if last_section != self._section: + self._last_header = '' + + return '' + + +class _CppLintState(object): + """Maintains module-wide state..""" + + def __init__(self): + self.verbose_level = 1 # global setting. + self.error_count = 0 # global count of reported errors + # filters to apply when emitting error messages + self.filters = _DEFAULT_FILTERS[:] + # backup of filter list. Used to restore the state after each file. + self._filters_backup = self.filters[:] + self.counting = 'total' # In what way are we counting errors? + self.errors_by_category = {} # string to int dict storing error counts + + # output format: + # "emacs" - format that emacs can parse (default) + # "eclipse" - format that eclipse can parse + # "vs7" - format that Microsoft Visual Studio 7 can parse + # "junit" - format that Jenkins, Bamboo, etc can parse + self.output_format = 'emacs' + + # For JUnit output, save errors and failures until the end so that they + # can be written into the XML + self._junit_errors = [] + self._junit_failures = [] + + def SetOutputFormat(self, output_format): + """Sets the output format for errors.""" + self.output_format = output_format + + def SetVerboseLevel(self, level): + """Sets the module's verbosity, and returns the previous setting.""" + last_verbose_level = self.verbose_level + self.verbose_level = level + return last_verbose_level + + def SetCountingStyle(self, counting_style): + """Sets the module's counting options.""" + self.counting = counting_style + + def SetFilters(self, filters): + """Sets the error-message filters. + + These filters are applied when deciding whether to emit a given + error message. + + Args: + filters: A string of comma-separated filters (eg "+whitespace/indent"). + Each filter should start with + or -; else we die. + + Raises: + ValueError: The comma-separated filters did not all start with '+' or '-'. + E.g. "-,+whitespace,-whitespace/indent,whitespace/badfilter" + """ + # Default filters always have less priority than the flag ones. + self.filters = _DEFAULT_FILTERS[:] + self.AddFilters(filters) + + def AddFilters(self, filters): + """ Adds more filters to the existing list of error-message filters. """ + for filt in filters.split(','): + clean_filt = filt.strip() + if clean_filt: + self.filters.append(clean_filt) + for filt in self.filters: + if not (filt.startswith('+') or filt.startswith('-')): + raise ValueError('Every filter in --filters must start with + or -' + ' (%s does not)' % filt) + + def BackupFilters(self): + """ Saves the current filter list to backup storage.""" + self._filters_backup = self.filters[:] + + def RestoreFilters(self): + """ Restores filters previously backed up.""" + self.filters = self._filters_backup[:] + + def ResetErrorCounts(self): + """Sets the module's error statistic back to zero.""" + self.error_count = 0 + self.errors_by_category = {} + + def IncrementErrorCount(self, category): + """Bumps the module's error statistic.""" + self.error_count += 1 + if self.counting in ('toplevel', 'detailed'): + if self.counting != 'detailed': + category = category.split('/')[0] + if category not in self.errors_by_category: + self.errors_by_category[category] = 0 + self.errors_by_category[category] += 1 + + def PrintErrorCounts(self): + """Print a summary of errors by category, and the total.""" + for category, count in sorted(iteritems(self.errors_by_category)): + self.PrintInfo('Category \'%s\' errors found: %d\n' % + (category, count)) + if self.error_count > 0: + self.PrintInfo('Total errors found: %d\n' % self.error_count) + + def PrintInfo(self, message): + if not _quiet and self.output_format != 'junit': + sys.stderr.write(message) + + def PrintError(self, message): + if self.output_format == 'junit': + self._junit_errors.append(message) + else: + sys.stderr.write(message) + + def AddJUnitFailure(self, filename, linenum, message, category, confidence): + self._junit_failures.append((filename, linenum, message, category, + confidence)) + + def FormatJUnitXML(self): + num_errors = len(self._junit_errors) + num_failures = len(self._junit_failures) + + testsuite = xml.etree.ElementTree.Element('testsuite') + testsuite.attrib['name'] = 'cpplint' + testsuite.attrib['errors'] = str(num_errors) + testsuite.attrib['failures'] = str(num_failures) + + if num_errors == 0 and num_failures == 0: + testsuite.attrib['tests'] = str(1) + xml.etree.ElementTree.SubElement(testsuite, 'testcase', name='passed') + + else: + testsuite.attrib['tests'] = str(num_errors + num_failures) + if num_errors > 0: + testcase = xml.etree.ElementTree.SubElement(testsuite, 'testcase') + testcase.attrib['name'] = 'errors' + error = xml.etree.ElementTree.SubElement(testcase, 'error') + error.text = '\n'.join(self._junit_errors) + if num_failures > 0: + # Group failures by file + failed_file_order = [] + failures_by_file = {} + for failure in self._junit_failures: + failed_file = failure[0] + if failed_file not in failed_file_order: + failed_file_order.append(failed_file) + failures_by_file[failed_file] = [] + failures_by_file[failed_file].append(failure) + # Create a testcase for each file + for failed_file in failed_file_order: + failures = failures_by_file[failed_file] + testcase = xml.etree.ElementTree.SubElement(testsuite, 'testcase') + testcase.attrib['name'] = failed_file + failure = xml.etree.ElementTree.SubElement(testcase, 'failure') + template = '{0}: {1} [{2}] [{3}]' + texts = [template.format(f[1], f[2], f[3], f[4]) for f in failures] + failure.text = '\n'.join(texts) + + xml_decl = '\n' + return xml_decl + xml.etree.ElementTree.tostring(testsuite, 'utf-8').decode('utf-8') + + +_cpplint_state = _CppLintState() + + +def _OutputFormat(): + """Gets the module's output format.""" + return _cpplint_state.output_format + + +def _SetOutputFormat(output_format): + """Sets the module's output format.""" + _cpplint_state.SetOutputFormat(output_format) + + +def _VerboseLevel(): + """Returns the module's verbosity setting.""" + return _cpplint_state.verbose_level + + +def _SetVerboseLevel(level): + """Sets the module's verbosity, and returns the previous setting.""" + return _cpplint_state.SetVerboseLevel(level) + + +def _SetCountingStyle(level): + """Sets the module's counting options.""" + _cpplint_state.SetCountingStyle(level) + + +def _Filters(): + """Returns the module's list of output filters, as a list.""" + return _cpplint_state.filters + + +def _SetFilters(filters): + """Sets the module's error-message filters. + + These filters are applied when deciding whether to emit a given + error message. + + Args: + filters: A string of comma-separated filters (eg "whitespace/indent"). + Each filter should start with + or -; else we die. + """ + _cpplint_state.SetFilters(filters) + +def _AddFilters(filters): + """Adds more filter overrides. + + Unlike _SetFilters, this function does not reset the current list of filters + available. + + Args: + filters: A string of comma-separated filters (eg "whitespace/indent"). + Each filter should start with + or -; else we die. + """ + _cpplint_state.AddFilters(filters) + +def _BackupFilters(): + """ Saves the current filter list to backup storage.""" + _cpplint_state.BackupFilters() + +def _RestoreFilters(): + """ Restores filters previously backed up.""" + _cpplint_state.RestoreFilters() + +class _FunctionState(object): + """Tracks current function name and the number of lines in its body.""" + + _NORMAL_TRIGGER = 250 # for --v=0, 500 for --v=1, etc. + _TEST_TRIGGER = 400 # about 50% more than _NORMAL_TRIGGER. + + def __init__(self): + self.in_a_function = False + self.lines_in_function = 0 + self.current_function = '' + + def Begin(self, function_name): + """Start analyzing function body. + + Args: + function_name: The name of the function being tracked. + """ + self.in_a_function = True + self.lines_in_function = 0 + self.current_function = function_name + + def Count(self): + """Count line in current function body.""" + if self.in_a_function: + self.lines_in_function += 1 + + def Check(self, error, filename, linenum): + """Report if too many lines in function body. + + Args: + error: The function to call with any errors found. + filename: The name of the current file. + linenum: The number of the line to check. + """ + if not self.in_a_function: + return + + if Match(r'T(EST|est)', self.current_function): + base_trigger = self._TEST_TRIGGER + else: + base_trigger = self._NORMAL_TRIGGER + trigger = base_trigger * 2**_VerboseLevel() + + if self.lines_in_function > trigger: + error_level = int(math.log(self.lines_in_function / base_trigger, 2)) + # 50 => 0, 100 => 1, 200 => 2, 400 => 3, 800 => 4, 1600 => 5, ... + if error_level > 5: + error_level = 5 + error(filename, linenum, 'readability/fn_size', error_level, + 'Small and focused functions are preferred:' + ' %s has %d non-comment lines' + ' (error triggered by exceeding %d lines).' % ( + self.current_function, self.lines_in_function, trigger)) + + def End(self): + """Stop analyzing function body.""" + self.in_a_function = False + + +class _IncludeError(Exception): + """Indicates a problem with the include order in a file.""" + pass + + +class FileInfo(object): + """Provides utility functions for filenames. + + FileInfo provides easy access to the components of a file's path + relative to the project root. + """ + + def __init__(self, filename): + self._filename = filename + + def FullName(self): + """Make Windows paths like Unix.""" + return os.path.abspath(self._filename).replace('\\', '/') + + def RepositoryName(self): + r"""FullName after removing the local path to the repository. + + If we have a real absolute path name here we can try to do something smart: + detecting the root of the checkout and truncating /path/to/checkout from + the name so that we get header guards that don't include things like + "C:\Documents and Settings\..." or "/home/username/..." in them and thus + people on different computers who have checked the source out to different + locations won't see bogus errors. + """ + fullname = self.FullName() + + if os.path.exists(fullname): + project_dir = os.path.dirname(fullname) + + # If the user specified a repository path, it exists, and the file is + # contained in it, use the specified repository path + if _repository: + repo = FileInfo(_repository).FullName() + root_dir = project_dir + while os.path.exists(root_dir): + # allow case insensitive compare on Windows + if os.path.normcase(root_dir) == os.path.normcase(repo): + return os.path.relpath(fullname, root_dir).replace('\\', '/') + one_up_dir = os.path.dirname(root_dir) + if one_up_dir == root_dir: + break + root_dir = one_up_dir + + if os.path.exists(os.path.join(project_dir, ".svn")): + # If there's a .svn file in the current directory, we recursively look + # up the directory tree for the top of the SVN checkout + root_dir = project_dir + one_up_dir = os.path.dirname(root_dir) + while os.path.exists(os.path.join(one_up_dir, ".svn")): + root_dir = os.path.dirname(root_dir) + one_up_dir = os.path.dirname(one_up_dir) + + prefix = os.path.commonprefix([root_dir, project_dir]) + return fullname[len(prefix) + 1:] + + # Not SVN <= 1.6? Try to find a git, hg, or svn top level directory by + # searching up from the current path. + root_dir = current_dir = os.path.dirname(fullname) + while current_dir != os.path.dirname(current_dir): + if (os.path.exists(os.path.join(current_dir, ".git")) or + os.path.exists(os.path.join(current_dir, ".hg")) or + os.path.exists(os.path.join(current_dir, ".svn"))): + root_dir = current_dir + current_dir = os.path.dirname(current_dir) + + if (os.path.exists(os.path.join(root_dir, ".git")) or + os.path.exists(os.path.join(root_dir, ".hg")) or + os.path.exists(os.path.join(root_dir, ".svn"))): + prefix = os.path.commonprefix([root_dir, project_dir]) + return fullname[len(prefix) + 1:] + + # Don't know what to do; header guard warnings may be wrong... + return fullname + + def Split(self): + """Splits the file into the directory, basename, and extension. + + For 'chrome/browser/browser.cc', Split() would + return ('chrome/browser', 'browser', '.cc') + + Returns: + A tuple of (directory, basename, extension). + """ + + googlename = self.RepositoryName() + project, rest = os.path.split(googlename) + return (project,) + os.path.splitext(rest) + + def BaseName(self): + """File base name - text after the final slash, before the final period.""" + return self.Split()[1] + + def Extension(self): + """File extension - text following the final period, includes that period.""" + return self.Split()[2] + + def NoExtension(self): + """File has no source file extension.""" + return '/'.join(self.Split()[0:2]) + + def IsSource(self): + """File has a source file extension.""" + return _IsSourceExtension(self.Extension()[1:]) + + +def _ShouldPrintError(category, confidence, linenum): + """If confidence >= verbose, category passes filter and is not suppressed.""" + + # There are three ways we might decide not to print an error message: + # a "NOLINT(category)" comment appears in the source, + # the verbosity level isn't high enough, or the filters filter it out. + if IsErrorSuppressedByNolint(category, linenum): + return False + + if confidence < _cpplint_state.verbose_level: + return False + + is_filtered = False + for one_filter in _Filters(): + if one_filter.startswith('-'): + if category.startswith(one_filter[1:]): + is_filtered = True + elif one_filter.startswith('+'): + if category.startswith(one_filter[1:]): + is_filtered = False + else: + assert False # should have been checked for in SetFilter. + if is_filtered: + return False + + return True + + +def Error(filename, linenum, category, confidence, message): + """Logs the fact we've found a lint error. + + We log where the error was found, and also our confidence in the error, + that is, how certain we are this is a legitimate style regression, and + not a misidentification or a use that's sometimes justified. + + False positives can be suppressed by the use of + "cpplint(category)" comments on the offending line. These are + parsed into _error_suppressions. + + Args: + filename: The name of the file containing the error. + linenum: The number of the line containing the error. + category: A string used to describe the "category" this bug + falls under: "whitespace", say, or "runtime". Categories + may have a hierarchy separated by slashes: "whitespace/indent". + confidence: A number from 1-5 representing a confidence score for + the error, with 5 meaning that we are certain of the problem, + and 1 meaning that it could be a legitimate construct. + message: The error message. + """ + if _ShouldPrintError(category, confidence, linenum): + _cpplint_state.IncrementErrorCount(category) + if _cpplint_state.output_format == 'vs7': + _cpplint_state.PrintError('%s(%s): warning: %s [%s] [%d]\n' % ( + filename, linenum, message, category, confidence)) + elif _cpplint_state.output_format == 'eclipse': + sys.stderr.write('%s:%s: warning: %s [%s] [%d]\n' % ( + filename, linenum, message, category, confidence)) + elif _cpplint_state.output_format == 'junit': + _cpplint_state.AddJUnitFailure(filename, linenum, message, category, + confidence) + else: + final_message = '%s:%s: %s [%s] [%d]\n' % ( + filename, linenum, message, category, confidence) + sys.stderr.write(final_message) + +# Matches standard C++ escape sequences per 2.13.2.3 of the C++ standard. +_RE_PATTERN_CLEANSE_LINE_ESCAPES = re.compile( + r'\\([abfnrtv?"\\\']|\d+|x[0-9a-fA-F]+)') +# Match a single C style comment on the same line. +_RE_PATTERN_C_COMMENTS = r'/\*(?:[^*]|\*(?!/))*\*/' +# Matches multi-line C style comments. +# This RE is a little bit more complicated than one might expect, because we +# have to take care of space removals tools so we can handle comments inside +# statements better. +# The current rule is: We only clear spaces from both sides when we're at the +# end of the line. Otherwise, we try to remove spaces from the right side, +# if this doesn't work we try on left side but only if there's a non-character +# on the right. +_RE_PATTERN_CLEANSE_LINE_C_COMMENTS = re.compile( + r'(\s*' + _RE_PATTERN_C_COMMENTS + r'\s*$|' + + _RE_PATTERN_C_COMMENTS + r'\s+|' + + r'\s+' + _RE_PATTERN_C_COMMENTS + r'(?=\W)|' + + _RE_PATTERN_C_COMMENTS + r')') + + +def IsCppString(line): + """Does line terminate so, that the next symbol is in string constant. + + This function does not consider single-line nor multi-line comments. + + Args: + line: is a partial line of code starting from the 0..n. + + Returns: + True, if next character appended to 'line' is inside a + string constant. + """ + + line = line.replace(r'\\', 'XX') # after this, \\" does not match to \" + return ((line.count('"') - line.count(r'\"') - line.count("'\"'")) & 1) == 1 + + +def CleanseRawStrings(raw_lines): + """Removes C++11 raw strings from lines. + + Before: + static const char kData[] = R"( + multi-line string + )"; + + After: + static const char kData[] = "" + (replaced by blank line) + ""; + + Args: + raw_lines: list of raw lines. + + Returns: + list of lines with C++11 raw strings replaced by empty strings. + """ + + delimiter = None + lines_without_raw_strings = [] + for line in raw_lines: + if delimiter: + # Inside a raw string, look for the end + end = line.find(delimiter) + if end >= 0: + # Found the end of the string, match leading space for this + # line and resume copying the original lines, and also insert + # a "" on the last line. + leading_space = Match(r'^(\s*)\S', line) + line = leading_space.group(1) + '""' + line[end + len(delimiter):] + delimiter = None + else: + # Haven't found the end yet, append a blank line. + line = '""' + + # Look for beginning of a raw string, and replace them with + # empty strings. This is done in a loop to handle multiple raw + # strings on the same line. + while delimiter is None: + # Look for beginning of a raw string. + # See 2.14.15 [lex.string] for syntax. + # + # Once we have matched a raw string, we check the prefix of the + # line to make sure that the line is not part of a single line + # comment. It's done this way because we remove raw strings + # before removing comments as opposed to removing comments + # before removing raw strings. This is because there are some + # cpplint checks that requires the comments to be preserved, but + # we don't want to check comments that are inside raw strings. + matched = Match(r'^(.*?)\b(?:R|u8R|uR|UR|LR)"([^\s\\()]*)\((.*)$', line) + if (matched and + not Match(r'^([^\'"]|\'(\\.|[^\'])*\'|"(\\.|[^"])*")*//', + matched.group(1))): + delimiter = ')' + matched.group(2) + '"' + + end = matched.group(3).find(delimiter) + if end >= 0: + # Raw string ended on same line + line = (matched.group(1) + '""' + + matched.group(3)[end + len(delimiter):]) + delimiter = None + else: + # Start of a multi-line raw string + line = matched.group(1) + '""' + else: + break + + lines_without_raw_strings.append(line) + + # TODO(unknown): if delimiter is not None here, we might want to + # emit a warning for unterminated string. + return lines_without_raw_strings + + +def FindNextMultiLineCommentStart(lines, lineix): + """Find the beginning marker for a multiline comment.""" + while lineix < len(lines): + if lines[lineix].strip().startswith('/*'): + # Only return this marker if the comment goes beyond this line + if lines[lineix].strip().find('*/', 2) < 0: + return lineix + lineix += 1 + return len(lines) + + +def FindNextMultiLineCommentEnd(lines, lineix): + """We are inside a comment, find the end marker.""" + while lineix < len(lines): + if lines[lineix].strip().endswith('*/'): + return lineix + lineix += 1 + return len(lines) + + +def RemoveMultiLineCommentsFromRange(lines, begin, end): + """Clears a range of lines for multi-line comments.""" + # Having // dummy comments makes the lines non-empty, so we will not get + # unnecessary blank line warnings later in the code. + for i in range(begin, end): + lines[i] = '/**/' + + +def RemoveMultiLineComments(filename, lines, error): + """Removes multiline (c-style) comments from lines.""" + lineix = 0 + while lineix < len(lines): + lineix_begin = FindNextMultiLineCommentStart(lines, lineix) + if lineix_begin >= len(lines): + return + lineix_end = FindNextMultiLineCommentEnd(lines, lineix_begin) + if lineix_end >= len(lines): + error(filename, lineix_begin + 1, 'readability/multiline_comment', 5, + 'Could not find end of multi-line comment') + return + RemoveMultiLineCommentsFromRange(lines, lineix_begin, lineix_end + 1) + lineix = lineix_end + 1 + + +def CleanseComments(line): + """Removes //-comments and single-line C-style /* */ comments. + + Args: + line: A line of C++ source. + + Returns: + The line with single-line comments removed. + """ + commentpos = line.find('//') + if commentpos != -1 and not IsCppString(line[:commentpos]): + line = line[:commentpos].rstrip() + # get rid of /* ... */ + return _RE_PATTERN_CLEANSE_LINE_C_COMMENTS.sub('', line) + + +class CleansedLines(object): + """Holds 4 copies of all lines with different preprocessing applied to them. + + 1) elided member contains lines without strings and comments. + 2) lines member contains lines without comments. + 3) raw_lines member contains all the lines without processing. + 4) lines_without_raw_strings member is same as raw_lines, but with C++11 raw + strings removed. + All these members are of , and of the same length. + """ + + def __init__(self, lines): + self.elided = [] + self.lines = [] + self.raw_lines = lines + self.num_lines = len(lines) + self.lines_without_raw_strings = CleanseRawStrings(lines) + for linenum in range(len(self.lines_without_raw_strings)): + self.lines.append(CleanseComments( + self.lines_without_raw_strings[linenum])) + elided = self._CollapseStrings(self.lines_without_raw_strings[linenum]) + self.elided.append(CleanseComments(elided)) + + def NumLines(self): + """Returns the number of lines represented.""" + return self.num_lines + + @staticmethod + def _CollapseStrings(elided): + """Collapses strings and chars on a line to simple "" or '' blocks. + + We nix strings first so we're not fooled by text like '"http://"' + + Args: + elided: The line being processed. + + Returns: + The line with collapsed strings. + """ + if _RE_PATTERN_INCLUDE.match(elided): + return elided + + # Remove escaped characters first to make quote/single quote collapsing + # basic. Things that look like escaped characters shouldn't occur + # outside of strings and chars. + elided = _RE_PATTERN_CLEANSE_LINE_ESCAPES.sub('', elided) + + # Replace quoted strings and digit separators. Both single quotes + # and double quotes are processed in the same loop, otherwise + # nested quotes wouldn't work. + collapsed = '' + while True: + # Find the first quote character + match = Match(r'^([^\'"]*)([\'"])(.*)$', elided) + if not match: + collapsed += elided + break + head, quote, tail = match.groups() + + if quote == '"': + # Collapse double quoted strings + second_quote = tail.find('"') + if second_quote >= 0: + collapsed += head + '""' + elided = tail[second_quote + 1:] + else: + # Unmatched double quote, don't bother processing the rest + # of the line since this is probably a multiline string. + collapsed += elided + break + else: + # Found single quote, check nearby text to eliminate digit separators. + # + # There is no special handling for floating point here, because + # the integer/fractional/exponent parts would all be parsed + # correctly as long as there are digits on both sides of the + # separator. So we are fine as long as we don't see something + # like "0.'3" (gcc 4.9.0 will not allow this literal). + if Search(r'\b(?:0[bBxX]?|[1-9])[0-9a-fA-F]*$', head): + match_literal = Match(r'^((?:\'?[0-9a-zA-Z_])*)(.*)$', "'" + tail) + collapsed += head + match_literal.group(1).replace("'", '') + elided = match_literal.group(2) + else: + second_quote = tail.find('\'') + if second_quote >= 0: + collapsed += head + "''" + elided = tail[second_quote + 1:] + else: + # Unmatched single quote + collapsed += elided + break + + return collapsed + + +def FindEndOfExpressionInLine(line, startpos, stack): + """Find the position just after the end of current parenthesized expression. + + Args: + line: a CleansedLines line. + startpos: start searching at this position. + stack: nesting stack at startpos. + + Returns: + On finding matching end: (index just after matching end, None) + On finding an unclosed expression: (-1, None) + Otherwise: (-1, new stack at end of this line) + """ + for i in xrange(startpos, len(line)): + char = line[i] + if char in '([{': + # Found start of parenthesized expression, push to expression stack + stack.append(char) + elif char == '<': + # Found potential start of template argument list + if i > 0 and line[i - 1] == '<': + # Left shift operator + if stack and stack[-1] == '<': + stack.pop() + if not stack: + return (-1, None) + elif i > 0 and Search(r'\boperator\s*$', line[0:i]): + # operator<, don't add to stack + continue + else: + # Tentative start of template argument list + stack.append('<') + elif char in ')]}': + # Found end of parenthesized expression. + # + # If we are currently expecting a matching '>', the pending '<' + # must have been an operator. Remove them from expression stack. + while stack and stack[-1] == '<': + stack.pop() + if not stack: + return (-1, None) + if ((stack[-1] == '(' and char == ')') or + (stack[-1] == '[' and char == ']') or + (stack[-1] == '{' and char == '}')): + stack.pop() + if not stack: + return (i + 1, None) + else: + # Mismatched parentheses + return (-1, None) + elif char == '>': + # Found potential end of template argument list. + + # Ignore "->" and operator functions + if (i > 0 and + (line[i - 1] == '-' or Search(r'\boperator\s*$', line[0:i - 1]))): + continue + + # Pop the stack if there is a matching '<'. Otherwise, ignore + # this '>' since it must be an operator. + if stack: + if stack[-1] == '<': + stack.pop() + if not stack: + return (i + 1, None) + elif char == ';': + # Found something that look like end of statements. If we are currently + # expecting a '>', the matching '<' must have been an operator, since + # template argument list should not contain statements. + while stack and stack[-1] == '<': + stack.pop() + if not stack: + return (-1, None) + + # Did not find end of expression or unbalanced parentheses on this line + return (-1, stack) + + +def CloseExpression(clean_lines, linenum, pos): + """If input points to ( or { or [ or <, finds the position that closes it. + + If lines[linenum][pos] points to a '(' or '{' or '[' or '<', finds the + linenum/pos that correspond to the closing of the expression. + + TODO(unknown): cpplint spends a fair bit of time matching parentheses. + Ideally we would want to index all opening and closing parentheses once + and have CloseExpression be just a simple lookup, but due to preprocessor + tricks, this is not so easy. + + Args: + clean_lines: A CleansedLines instance containing the file. + linenum: The number of the line to check. + pos: A position on the line. + + Returns: + A tuple (line, linenum, pos) pointer *past* the closing brace, or + (line, len(lines), -1) if we never find a close. Note we ignore + strings and comments when matching; and the line we return is the + 'cleansed' line at linenum. + """ + + line = clean_lines.elided[linenum] + if (line[pos] not in '({[<') or Match(r'<[<=]', line[pos:]): + return (line, clean_lines.NumLines(), -1) + + # Check first line + (end_pos, stack) = FindEndOfExpressionInLine(line, pos, []) + if end_pos > -1: + return (line, linenum, end_pos) + + # Continue scanning forward + while stack and linenum < clean_lines.NumLines() - 1: + linenum += 1 + line = clean_lines.elided[linenum] + (end_pos, stack) = FindEndOfExpressionInLine(line, 0, stack) + if end_pos > -1: + return (line, linenum, end_pos) + + # Did not find end of expression before end of file, give up + return (line, clean_lines.NumLines(), -1) + + +def FindStartOfExpressionInLine(line, endpos, stack): + """Find position at the matching start of current expression. + + This is almost the reverse of FindEndOfExpressionInLine, but note + that the input position and returned position differs by 1. + + Args: + line: a CleansedLines line. + endpos: start searching at this position. + stack: nesting stack at endpos. + + Returns: + On finding matching start: (index at matching start, None) + On finding an unclosed expression: (-1, None) + Otherwise: (-1, new stack at beginning of this line) + """ + i = endpos + while i >= 0: + char = line[i] + if char in ')]}': + # Found end of expression, push to expression stack + stack.append(char) + elif char == '>': + # Found potential end of template argument list. + # + # Ignore it if it's a "->" or ">=" or "operator>" + if (i > 0 and + (line[i - 1] == '-' or + Match(r'\s>=\s', line[i - 1:]) or + Search(r'\boperator\s*$', line[0:i]))): + i -= 1 + else: + stack.append('>') + elif char == '<': + # Found potential start of template argument list + if i > 0 and line[i - 1] == '<': + # Left shift operator + i -= 1 + else: + # If there is a matching '>', we can pop the expression stack. + # Otherwise, ignore this '<' since it must be an operator. + if stack and stack[-1] == '>': + stack.pop() + if not stack: + return (i, None) + elif char in '([{': + # Found start of expression. + # + # If there are any unmatched '>' on the stack, they must be + # operators. Remove those. + while stack and stack[-1] == '>': + stack.pop() + if not stack: + return (-1, None) + if ((char == '(' and stack[-1] == ')') or + (char == '[' and stack[-1] == ']') or + (char == '{' and stack[-1] == '}')): + stack.pop() + if not stack: + return (i, None) + else: + # Mismatched parentheses + return (-1, None) + elif char == ';': + # Found something that look like end of statements. If we are currently + # expecting a '<', the matching '>' must have been an operator, since + # template argument list should not contain statements. + while stack and stack[-1] == '>': + stack.pop() + if not stack: + return (-1, None) + + i -= 1 + + return (-1, stack) + + +def ReverseCloseExpression(clean_lines, linenum, pos): + """If input points to ) or } or ] or >, finds the position that opens it. + + If lines[linenum][pos] points to a ')' or '}' or ']' or '>', finds the + linenum/pos that correspond to the opening of the expression. + + Args: + clean_lines: A CleansedLines instance containing the file. + linenum: The number of the line to check. + pos: A position on the line. + + Returns: + A tuple (line, linenum, pos) pointer *at* the opening brace, or + (line, 0, -1) if we never find the matching opening brace. Note + we ignore strings and comments when matching; and the line we + return is the 'cleansed' line at linenum. + """ + line = clean_lines.elided[linenum] + if line[pos] not in ')}]>': + return (line, 0, -1) + + # Check last line + (start_pos, stack) = FindStartOfExpressionInLine(line, pos, []) + if start_pos > -1: + return (line, linenum, start_pos) + + # Continue scanning backward + while stack and linenum > 0: + linenum -= 1 + line = clean_lines.elided[linenum] + (start_pos, stack) = FindStartOfExpressionInLine(line, len(line) - 1, stack) + if start_pos > -1: + return (line, linenum, start_pos) + + # Did not find start of expression before beginning of file, give up + return (line, 0, -1) + + +def CheckForCopyright(filename, lines, error): + """Logs an error if no Copyright message appears at the top of the file.""" + + # We'll say it should occur by line 10. Don't forget there's a + # dummy line at the front. + for line in range(1, min(len(lines), 11)): + if re.search(r'Copyright', lines[line], re.I): break + else: # means no copyright line was found + error(filename, 0, 'legal/copyright', 5, + 'No copyright message found. ' + 'You should have a line: "Copyright [year] "') + + +def GetIndentLevel(line): + """Return the number of leading spaces in line. + + Args: + line: A string to check. + + Returns: + An integer count of leading spaces, possibly zero. + """ + indent = Match(r'^( *)\S', line) + if indent: + return len(indent.group(1)) + else: + return 0 + + +def GetHeaderGuardCPPVariable(filename): + """Returns the CPP variable that should be used as a header guard. + + Args: + filename: The name of a C++ header file. + + Returns: + The CPP variable that should be used as a header guard in the + named file. + + """ + + # Restores original filename in case that cpplint is invoked from Emacs's + # flymake. + filename = re.sub(r'_flymake\.h$', '.h', filename) + filename = re.sub(r'/\.flymake/([^/]*)$', r'/\1', filename) + # Replace 'c++' with 'cpp'. + filename = filename.replace('C++', 'cpp').replace('c++', 'cpp') + + fileinfo = FileInfo(filename) + file_path_from_root = fileinfo.RepositoryName() + if _root: + suffix = os.sep + # On Windows using directory separator will leave us with + # "bogus escape error" unless we properly escape regex. + if suffix == '\\': + suffix += '\\' + file_path_from_root = re.sub('^' + _root + suffix, '', file_path_from_root) + return re.sub(r'[^a-zA-Z0-9]', '_', file_path_from_root).upper() + '_' + + +def CheckForHeaderGuard(filename, clean_lines, error): + """Checks that the file contains a header guard. + + Logs an error if no #ifndef header guard is present. For other + headers, checks that the full pathname is used. + + Args: + filename: The name of the C++ header file. + clean_lines: A CleansedLines instance containing the file. + error: The function to call with any errors found. + """ + + # Don't check for header guards if there are error suppression + # comments somewhere in this file. + # + # Because this is silencing a warning for a nonexistent line, we + # only support the very specific NOLINT(build/header_guard) syntax, + # and not the general NOLINT or NOLINT(*) syntax. + raw_lines = clean_lines.lines_without_raw_strings + for i in raw_lines: + if Search(r'//\s*NOLINT\(build/header_guard\)', i): + return + + # Allow pragma once instead of header guards + for i in raw_lines: + if Search(r'^\s*#pragma\s+once', i): + return + + cppvar = GetHeaderGuardCPPVariable(filename) + + ifndef = '' + ifndef_linenum = 0 + define = '' + endif = '' + endif_linenum = 0 + for linenum, line in enumerate(raw_lines): + linesplit = line.split() + if len(linesplit) >= 2: + # find the first occurrence of #ifndef and #define, save arg + if not ifndef and linesplit[0] == '#ifndef': + # set ifndef to the header guard presented on the #ifndef line. + ifndef = linesplit[1] + ifndef_linenum = linenum + if not define and linesplit[0] == '#define': + define = linesplit[1] + # find the last occurrence of #endif, save entire line + if line.startswith('#endif'): + endif = line + endif_linenum = linenum + + if not ifndef or not define or ifndef != define: + error(filename, 0, 'build/header_guard', 5, + 'No #ifndef header guard found, suggested CPP variable is: %s' % + cppvar) + return + + # The guard should be PATH_FILE_H_, but we also allow PATH_FILE_H__ + # for backward compatibility. + if ifndef != cppvar: + error_level = 0 + if ifndef != cppvar + '_': + error_level = 5 + + ParseNolintSuppressions(filename, raw_lines[ifndef_linenum], ifndef_linenum, + error) + error(filename, ifndef_linenum, 'build/header_guard', error_level, + '#ifndef header guard has wrong style, please use: %s' % cppvar) + + # Check for "//" comments on endif line. + ParseNolintSuppressions(filename, raw_lines[endif_linenum], endif_linenum, + error) + match = Match(r'#endif\s*//\s*' + cppvar + r'(_)?\b', endif) + if match: + if match.group(1) == '_': + # Issue low severity warning for deprecated double trailing underscore + error(filename, endif_linenum, 'build/header_guard', 0, + '#endif line should be "#endif // %s"' % cppvar) + return + + # Didn't find the corresponding "//" comment. If this file does not + # contain any "//" comments at all, it could be that the compiler + # only wants "/**/" comments, look for those instead. + no_single_line_comments = True + for i in xrange(1, len(raw_lines) - 1): + line = raw_lines[i] + if Match(r'^(?:(?:\'(?:\.|[^\'])*\')|(?:"(?:\.|[^"])*")|[^\'"])*//', line): + no_single_line_comments = False + break + + if no_single_line_comments: + match = Match(r'#endif\s*/\*\s*' + cppvar + r'(_)?\s*\*/', endif) + if match: + if match.group(1) == '_': + # Low severity warning for double trailing underscore + error(filename, endif_linenum, 'build/header_guard', 0, + '#endif line should be "#endif /* %s */"' % cppvar) + return + + # Didn't find anything + error(filename, endif_linenum, 'build/header_guard', 5, + '#endif line should be "#endif // %s"' % cppvar) + + +def CheckHeaderFileIncluded(filename, include_state, error): + """Logs an error if a source file does not include its header.""" + + # Do not check test files + fileinfo = FileInfo(filename) + if Search(_TEST_FILE_SUFFIX, fileinfo.BaseName()): + return + + for ext in GetHeaderExtensions(): + basefilename = filename[0:len(filename) - len(fileinfo.Extension())] + headerfile = basefilename + '.' + ext + if not os.path.exists(headerfile): + continue + headername = FileInfo(headerfile).RepositoryName() + first_include = None + for section_list in include_state.include_list: + for f in section_list: + if headername in f[0] or f[0] in headername: + return + if not first_include: + first_include = f[1] + + error(filename, first_include, 'build/include', 5, + '%s should include its header file %s' % (fileinfo.RepositoryName(), + headername)) + + +def CheckForBadCharacters(filename, lines, error): + """Logs an error for each line containing bad characters. + + Two kinds of bad characters: + + 1. Unicode replacement characters: These indicate that either the file + contained invalid UTF-8 (likely) or Unicode replacement characters (which + it shouldn't). Note that it's possible for this to throw off line + numbering if the invalid UTF-8 occurred adjacent to a newline. + + 2. NUL bytes. These are problematic for some tools. + + Args: + filename: The name of the current file. + lines: An array of strings, each representing a line of the file. + error: The function to call with any errors found. + """ + for linenum, line in enumerate(lines): + if unicode_escape_decode('\ufffd') in line: + error(filename, linenum, 'readability/utf8', 5, + 'Line contains invalid UTF-8 (or Unicode replacement character).') + if '\0' in line: + error(filename, linenum, 'readability/nul', 5, 'Line contains NUL byte.') + + +def CheckForNewlineAtEOF(filename, lines, error): + """Logs an error if there is no newline char at the end of the file. + + Args: + filename: The name of the current file. + lines: An array of strings, each representing a line of the file. + error: The function to call with any errors found. + """ + + # The array lines() was created by adding two newlines to the + # original file (go figure), then splitting on \n. + # To verify that the file ends in \n, we just have to make sure the + # last-but-two element of lines() exists and is empty. + if len(lines) < 3 or lines[-2]: + error(filename, len(lines) - 2, 'whitespace/ending_newline', 5, + 'Could not find a newline character at the end of the file.') + + +def CheckForMultilineCommentsAndStrings(filename, clean_lines, linenum, error): + """Logs an error if we see /* ... */ or "..." that extend past one line. + + /* ... */ comments are legit inside macros, for one line. + Otherwise, we prefer // comments, so it's ok to warn about the + other. Likewise, it's ok for strings to extend across multiple + lines, as long as a line continuation character (backslash) + terminates each line. Although not currently prohibited by the C++ + style guide, it's ugly and unnecessary. We don't do well with either + in this lint program, so we warn about both. + + Args: + filename: The name of the current file. + clean_lines: A CleansedLines instance containing the file. + linenum: The number of the line to check. + error: The function to call with any errors found. + """ + line = clean_lines.elided[linenum] + + # Remove all \\ (escaped backslashes) from the line. They are OK, and the + # second (escaped) slash may trigger later \" detection erroneously. + line = line.replace('\\\\', '') + + if line.count('/*') > line.count('*/'): + error(filename, linenum, 'readability/multiline_comment', 5, + 'Complex multi-line /*...*/-style comment found. ' + 'Lint may give bogus warnings. ' + 'Consider replacing these with //-style comments, ' + 'with #if 0...#endif, ' + 'or with more clearly structured multi-line comments.') + + if (line.count('"') - line.count('\\"')) % 2: + error(filename, linenum, 'readability/multiline_string', 5, + 'Multi-line string ("...") found. This lint script doesn\'t ' + 'do well with such strings, and may give bogus warnings. ' + 'Use C++11 raw strings or concatenation instead.') + + +# (non-threadsafe name, thread-safe alternative, validation pattern) +# +# The validation pattern is used to eliminate false positives such as: +# _rand(); // false positive due to substring match. +# ->rand(); // some member function rand(). +# ACMRandom rand(seed); // some variable named rand. +# ISAACRandom rand(); // another variable named rand. +# +# Basically we require the return value of these functions to be used +# in some expression context on the same line by matching on some +# operator before the function name. This eliminates constructors and +# member function calls. +_UNSAFE_FUNC_PREFIX = r'(?:[-+*/=%^&|(<]\s*|>\s+)' +_THREADING_LIST = ( + ('asctime(', 'asctime_r(', _UNSAFE_FUNC_PREFIX + r'asctime\([^)]+\)'), + ('ctime(', 'ctime_r(', _UNSAFE_FUNC_PREFIX + r'ctime\([^)]+\)'), + ('getgrgid(', 'getgrgid_r(', _UNSAFE_FUNC_PREFIX + r'getgrgid\([^)]+\)'), + ('getgrnam(', 'getgrnam_r(', _UNSAFE_FUNC_PREFIX + r'getgrnam\([^)]+\)'), + ('getlogin(', 'getlogin_r(', _UNSAFE_FUNC_PREFIX + r'getlogin\(\)'), + ('getpwnam(', 'getpwnam_r(', _UNSAFE_FUNC_PREFIX + r'getpwnam\([^)]+\)'), + ('getpwuid(', 'getpwuid_r(', _UNSAFE_FUNC_PREFIX + r'getpwuid\([^)]+\)'), + ('gmtime(', 'gmtime_r(', _UNSAFE_FUNC_PREFIX + r'gmtime\([^)]+\)'), + ('localtime(', 'localtime_r(', _UNSAFE_FUNC_PREFIX + r'localtime\([^)]+\)'), + ('rand(', 'rand_r(', _UNSAFE_FUNC_PREFIX + r'rand\(\)'), + ('strtok(', 'strtok_r(', + _UNSAFE_FUNC_PREFIX + r'strtok\([^)]+\)'), + ('ttyname(', 'ttyname_r(', _UNSAFE_FUNC_PREFIX + r'ttyname\([^)]+\)'), + ) + + +def CheckPosixThreading(filename, clean_lines, linenum, error): + """Checks for calls to thread-unsafe functions. + + Much code has been originally written without consideration of + multi-threading. Also, engineers are relying on their old experience; + they have learned posix before threading extensions were added. These + tests guide the engineers to use thread-safe functions (when using + posix directly). + + Args: + filename: The name of the current file. + clean_lines: A CleansedLines instance containing the file. + linenum: The number of the line to check. + error: The function to call with any errors found. + """ + line = clean_lines.elided[linenum] + for single_thread_func, multithread_safe_func, pattern in _THREADING_LIST: + # Additional pattern matching check to confirm that this is the + # function we are looking for + if Search(pattern, line): + error(filename, linenum, 'runtime/threadsafe_fn', 2, + 'Consider using ' + multithread_safe_func + + '...) instead of ' + single_thread_func + + '...) for improved thread safety.') + + +def CheckVlogArguments(filename, clean_lines, linenum, error): + """Checks that VLOG() is only used for defining a logging level. + + For example, VLOG(2) is correct. VLOG(INFO), VLOG(WARNING), VLOG(ERROR), and + VLOG(FATAL) are not. + + Args: + filename: The name of the current file. + clean_lines: A CleansedLines instance containing the file. + linenum: The number of the line to check. + error: The function to call with any errors found. + """ + line = clean_lines.elided[linenum] + if Search(r'\bVLOG\((INFO|ERROR|WARNING|DFATAL|FATAL)\)', line): + error(filename, linenum, 'runtime/vlog', 5, + 'VLOG() should be used with numeric verbosity level. ' + 'Use LOG() if you want symbolic severity levels.') + +# Matches invalid increment: *count++, which moves pointer instead of +# incrementing a value. +_RE_PATTERN_INVALID_INCREMENT = re.compile( + r'^\s*\*\w+(\+\+|--);') + + +def CheckInvalidIncrement(filename, clean_lines, linenum, error): + """Checks for invalid increment *count++. + + For example following function: + void increment_counter(int* count) { + *count++; + } + is invalid, because it effectively does count++, moving pointer, and should + be replaced with ++*count, (*count)++ or *count += 1. + + Args: + filename: The name of the current file. + clean_lines: A CleansedLines instance containing the file. + linenum: The number of the line to check. + error: The function to call with any errors found. + """ + line = clean_lines.elided[linenum] + if _RE_PATTERN_INVALID_INCREMENT.match(line): + error(filename, linenum, 'runtime/invalid_increment', 5, + 'Changing pointer instead of value (or unused value of operator*).') + + +def IsMacroDefinition(clean_lines, linenum): + if Search(r'^#define', clean_lines[linenum]): + return True + + if linenum > 0 and Search(r'\\$', clean_lines[linenum - 1]): + return True + + return False + + +def IsForwardClassDeclaration(clean_lines, linenum): + return Match(r'^\s*(\btemplate\b)*.*class\s+\w+;\s*$', clean_lines[linenum]) + + +class _BlockInfo(object): + """Stores information about a generic block of code.""" + + def __init__(self, linenum, seen_open_brace): + self.starting_linenum = linenum + self.seen_open_brace = seen_open_brace + self.open_parentheses = 0 + self.inline_asm = _NO_ASM + self.check_namespace_indentation = False + + def CheckBegin(self, filename, clean_lines, linenum, error): + """Run checks that applies to text up to the opening brace. + + This is mostly for checking the text after the class identifier + and the "{", usually where the base class is specified. For other + blocks, there isn't much to check, so we always pass. + + Args: + filename: The name of the current file. + clean_lines: A CleansedLines instance containing the file. + linenum: The number of the line to check. + error: The function to call with any errors found. + """ + pass + + def CheckEnd(self, filename, clean_lines, linenum, error): + """Run checks that applies to text after the closing brace. + + This is mostly used for checking end of namespace comments. + + Args: + filename: The name of the current file. + clean_lines: A CleansedLines instance containing the file. + linenum: The number of the line to check. + error: The function to call with any errors found. + """ + pass + + def IsBlockInfo(self): + """Returns true if this block is a _BlockInfo. + + This is convenient for verifying that an object is an instance of + a _BlockInfo, but not an instance of any of the derived classes. + + Returns: + True for this class, False for derived classes. + """ + return self.__class__ == _BlockInfo + + +class _ExternCInfo(_BlockInfo): + """Stores information about an 'extern "C"' block.""" + + def __init__(self, linenum): + _BlockInfo.__init__(self, linenum, True) + + +class _ClassInfo(_BlockInfo): + """Stores information about a class.""" + + def __init__(self, name, class_or_struct, clean_lines, linenum): + _BlockInfo.__init__(self, linenum, False) + self.name = name + self.is_derived = False + self.check_namespace_indentation = True + if class_or_struct == 'struct': + self.access = 'public' + self.is_struct = True + else: + self.access = 'private' + self.is_struct = False + + # Remember initial indentation level for this class. Using raw_lines here + # instead of elided to account for leading comments. + self.class_indent = GetIndentLevel(clean_lines.raw_lines[linenum]) + + # Try to find the end of the class. This will be confused by things like: + # class A { + # } *x = { ... + # + # But it's still good enough for CheckSectionSpacing. + self.last_line = 0 + depth = 0 + for i in range(linenum, clean_lines.NumLines()): + line = clean_lines.elided[i] + depth += line.count('{') - line.count('}') + if not depth: + self.last_line = i + break + + def CheckBegin(self, filename, clean_lines, linenum, error): + # Look for a bare ':' + if Search('(^|[^:]):($|[^:])', clean_lines.elided[linenum]): + self.is_derived = True + + def CheckEnd(self, filename, clean_lines, linenum, error): + # If there is a DISALLOW macro, it should appear near the end of + # the class. + seen_last_thing_in_class = False + for i in xrange(linenum - 1, self.starting_linenum, -1): + match = Search( + r'\b(DISALLOW_COPY_AND_ASSIGN|DISALLOW_IMPLICIT_CONSTRUCTORS)\(' + + self.name + r'\)', + clean_lines.elided[i]) + if match: + if seen_last_thing_in_class: + error(filename, i, 'readability/constructors', 3, + match.group(1) + ' should be the last thing in the class') + break + + if not Match(r'^\s*$', clean_lines.elided[i]): + seen_last_thing_in_class = True + + # Check that closing brace is aligned with beginning of the class. + # Only do this if the closing brace is indented by only whitespaces. + # This means we will not check single-line class definitions. + indent = Match(r'^( *)\}', clean_lines.elided[linenum]) + if indent and len(indent.group(1)) != self.class_indent: + if self.is_struct: + parent = 'struct ' + self.name + else: + parent = 'class ' + self.name + error(filename, linenum, 'whitespace/indent', 3, + 'Closing brace should be aligned with beginning of %s' % parent) + + +class _NamespaceInfo(_BlockInfo): + """Stores information about a namespace.""" + + def __init__(self, name, linenum): + _BlockInfo.__init__(self, linenum, False) + self.name = name or '' + self.check_namespace_indentation = True + + def CheckEnd(self, filename, clean_lines, linenum, error): + """Check end of namespace comments.""" + line = clean_lines.raw_lines[linenum] + + # Check how many lines is enclosed in this namespace. Don't issue + # warning for missing namespace comments if there aren't enough + # lines. However, do apply checks if there is already an end of + # namespace comment and it's incorrect. + # + # TODO(unknown): We always want to check end of namespace comments + # if a namespace is large, but sometimes we also want to apply the + # check if a short namespace contained nontrivial things (something + # other than forward declarations). There is currently no logic on + # deciding what these nontrivial things are, so this check is + # triggered by namespace size only, which works most of the time. + if (linenum - self.starting_linenum < 10 + and not Match(r'^\s*};*\s*(//|/\*).*\bnamespace\b', line)): + return + + # Look for matching comment at end of namespace. + # + # Note that we accept C style "/* */" comments for terminating + # namespaces, so that code that terminate namespaces inside + # preprocessor macros can be cpplint clean. + # + # We also accept stuff like "// end of namespace ." with the + # period at the end. + # + # Besides these, we don't accept anything else, otherwise we might + # get false negatives when existing comment is a substring of the + # expected namespace. + if self.name: + # Named namespace + if not Match((r'^\s*};*\s*(//|/\*).*\bnamespace\s+' + + re.escape(self.name) + r'[\*/\.\\\s]*$'), + line): + error(filename, linenum, 'readability/namespace', 5, + 'Namespace should be terminated with "// namespace %s"' % + self.name) + else: + # Anonymous namespace + if not Match(r'^\s*};*\s*(//|/\*).*\bnamespace[\*/\.\\\s]*$', line): + # If "// namespace anonymous" or "// anonymous namespace (more text)", + # mention "// anonymous namespace" as an acceptable form + if Match(r'^\s*}.*\b(namespace anonymous|anonymous namespace)\b', line): + error(filename, linenum, 'readability/namespace', 5, + 'Anonymous namespace should be terminated with "// namespace"' + ' or "// anonymous namespace"') + else: + error(filename, linenum, 'readability/namespace', 5, + 'Anonymous namespace should be terminated with "// namespace"') + + +class _PreprocessorInfo(object): + """Stores checkpoints of nesting stacks when #if/#else is seen.""" + + def __init__(self, stack_before_if): + # The entire nesting stack before #if + self.stack_before_if = stack_before_if + + # The entire nesting stack up to #else + self.stack_before_else = [] + + # Whether we have already seen #else or #elif + self.seen_else = False + + +class NestingState(object): + """Holds states related to parsing braces.""" + + def __init__(self): + # Stack for tracking all braces. An object is pushed whenever we + # see a "{", and popped when we see a "}". Only 3 types of + # objects are possible: + # - _ClassInfo: a class or struct. + # - _NamespaceInfo: a namespace. + # - _BlockInfo: some other type of block. + self.stack = [] + + # Top of the previous stack before each Update(). + # + # Because the nesting_stack is updated at the end of each line, we + # had to do some convoluted checks to find out what is the current + # scope at the beginning of the line. This check is simplified by + # saving the previous top of nesting stack. + # + # We could save the full stack, but we only need the top. Copying + # the full nesting stack would slow down cpplint by ~10%. + self.previous_stack_top = [] + + # Stack of _PreprocessorInfo objects. + self.pp_stack = [] + + def SeenOpenBrace(self): + """Check if we have seen the opening brace for the innermost block. + + Returns: + True if we have seen the opening brace, False if the innermost + block is still expecting an opening brace. + """ + return (not self.stack) or self.stack[-1].seen_open_brace + + def InNamespaceBody(self): + """Check if we are currently one level inside a namespace body. + + Returns: + True if top of the stack is a namespace block, False otherwise. + """ + return self.stack and isinstance(self.stack[-1], _NamespaceInfo) + + def InExternC(self): + """Check if we are currently one level inside an 'extern "C"' block. + + Returns: + True if top of the stack is an extern block, False otherwise. + """ + return self.stack and isinstance(self.stack[-1], _ExternCInfo) + + def InClassDeclaration(self): + """Check if we are currently one level inside a class or struct declaration. + + Returns: + True if top of the stack is a class/struct, False otherwise. + """ + return self.stack and isinstance(self.stack[-1], _ClassInfo) + + def InAsmBlock(self): + """Check if we are currently one level inside an inline ASM block. + + Returns: + True if the top of the stack is a block containing inline ASM. + """ + return self.stack and self.stack[-1].inline_asm != _NO_ASM + + def InTemplateArgumentList(self, clean_lines, linenum, pos): + """Check if current position is inside template argument list. + + Args: + clean_lines: A CleansedLines instance containing the file. + linenum: The number of the line to check. + pos: position just after the suspected template argument. + Returns: + True if (linenum, pos) is inside template arguments. + """ + while linenum < clean_lines.NumLines(): + # Find the earliest character that might indicate a template argument + line = clean_lines.elided[linenum] + match = Match(r'^[^{};=\[\]\.<>]*(.)', line[pos:]) + if not match: + linenum += 1 + pos = 0 + continue + token = match.group(1) + pos += len(match.group(0)) + + # These things do not look like template argument list: + # class Suspect { + # class Suspect x; } + if token in ('{', '}', ';'): return False + + # These things look like template argument list: + # template + # template + # template + # template + if token in ('>', '=', '[', ']', '.'): return True + + # Check if token is an unmatched '<'. + # If not, move on to the next character. + if token != '<': + pos += 1 + if pos >= len(line): + linenum += 1 + pos = 0 + continue + + # We can't be sure if we just find a single '<', and need to + # find the matching '>'. + (_, end_line, end_pos) = CloseExpression(clean_lines, linenum, pos - 1) + if end_pos < 0: + # Not sure if template argument list or syntax error in file + return False + linenum = end_line + pos = end_pos + return False + + def UpdatePreprocessor(self, line): + """Update preprocessor stack. + + We need to handle preprocessors due to classes like this: + #ifdef SWIG + struct ResultDetailsPageElementExtensionPoint { + #else + struct ResultDetailsPageElementExtensionPoint : public Extension { + #endif + + We make the following assumptions (good enough for most files): + - Preprocessor condition evaluates to true from #if up to first + #else/#elif/#endif. + + - Preprocessor condition evaluates to false from #else/#elif up + to #endif. We still perform lint checks on these lines, but + these do not affect nesting stack. + + Args: + line: current line to check. + """ + if Match(r'^\s*#\s*(if|ifdef|ifndef)\b', line): + # Beginning of #if block, save the nesting stack here. The saved + # stack will allow us to restore the parsing state in the #else case. + self.pp_stack.append(_PreprocessorInfo(copy.deepcopy(self.stack))) + elif Match(r'^\s*#\s*(else|elif)\b', line): + # Beginning of #else block + if self.pp_stack: + if not self.pp_stack[-1].seen_else: + # This is the first #else or #elif block. Remember the + # whole nesting stack up to this point. This is what we + # keep after the #endif. + self.pp_stack[-1].seen_else = True + self.pp_stack[-1].stack_before_else = copy.deepcopy(self.stack) + + # Restore the stack to how it was before the #if + self.stack = copy.deepcopy(self.pp_stack[-1].stack_before_if) + else: + # TODO(unknown): unexpected #else, issue warning? + pass + elif Match(r'^\s*#\s*endif\b', line): + # End of #if or #else blocks. + if self.pp_stack: + # If we saw an #else, we will need to restore the nesting + # stack to its former state before the #else, otherwise we + # will just continue from where we left off. + if self.pp_stack[-1].seen_else: + # Here we can just use a shallow copy since we are the last + # reference to it. + self.stack = self.pp_stack[-1].stack_before_else + # Drop the corresponding #if + self.pp_stack.pop() + else: + # TODO(unknown): unexpected #endif, issue warning? + pass + + # TODO(unknown): Update() is too long, but we will refactor later. + def Update(self, filename, clean_lines, linenum, error): + """Update nesting state with current line. + + Args: + filename: The name of the current file. + clean_lines: A CleansedLines instance containing the file. + linenum: The number of the line to check. + error: The function to call with any errors found. + """ + line = clean_lines.elided[linenum] + + # Remember top of the previous nesting stack. + # + # The stack is always pushed/popped and not modified in place, so + # we can just do a shallow copy instead of copy.deepcopy. Using + # deepcopy would slow down cpplint by ~28%. + if self.stack: + self.previous_stack_top = self.stack[-1] + else: + self.previous_stack_top = None + + # Update pp_stack + self.UpdatePreprocessor(line) + + # Count parentheses. This is to avoid adding struct arguments to + # the nesting stack. + if self.stack: + inner_block = self.stack[-1] + depth_change = line.count('(') - line.count(')') + inner_block.open_parentheses += depth_change + + # Also check if we are starting or ending an inline assembly block. + if inner_block.inline_asm in (_NO_ASM, _END_ASM): + if (depth_change != 0 and + inner_block.open_parentheses == 1 and + _MATCH_ASM.match(line)): + # Enter assembly block + inner_block.inline_asm = _INSIDE_ASM + else: + # Not entering assembly block. If previous line was _END_ASM, + # we will now shift to _NO_ASM state. + inner_block.inline_asm = _NO_ASM + elif (inner_block.inline_asm == _INSIDE_ASM and + inner_block.open_parentheses == 0): + # Exit assembly block + inner_block.inline_asm = _END_ASM + + # Consume namespace declaration at the beginning of the line. Do + # this in a loop so that we catch same line declarations like this: + # namespace proto2 { namespace bridge { class MessageSet; } } + while True: + # Match start of namespace. The "\b\s*" below catches namespace + # declarations even if it weren't followed by a whitespace, this + # is so that we don't confuse our namespace checker. The + # missing spaces will be flagged by CheckSpacing. + namespace_decl_match = Match(r'^\s*namespace\b\s*([:\w]+)?(.*)$', line) + if not namespace_decl_match: + break + + new_namespace = _NamespaceInfo(namespace_decl_match.group(1), linenum) + self.stack.append(new_namespace) + + line = namespace_decl_match.group(2) + if line.find('{') != -1: + new_namespace.seen_open_brace = True + line = line[line.find('{') + 1:] + + # Look for a class declaration in whatever is left of the line + # after parsing namespaces. The regexp accounts for decorated classes + # such as in: + # class LOCKABLE API Object { + # }; + class_decl_match = Match( + r'^(\s*(?:template\s*<[\w\s<>,:=]*>\s*)?' + r'(class|struct)\s+(?:[A-Z_]+\s+)*(\w+(?:::\w+)*))' + r'(.*)$', line) + if (class_decl_match and + (not self.stack or self.stack[-1].open_parentheses == 0)): + # We do not want to accept classes that are actually template arguments: + # template , + # template class Ignore3> + # void Function() {}; + # + # To avoid template argument cases, we scan forward and look for + # an unmatched '>'. If we see one, assume we are inside a + # template argument list. + end_declaration = len(class_decl_match.group(1)) + if not self.InTemplateArgumentList(clean_lines, linenum, end_declaration): + self.stack.append(_ClassInfo( + class_decl_match.group(3), class_decl_match.group(2), + clean_lines, linenum)) + line = class_decl_match.group(4) + + # If we have not yet seen the opening brace for the innermost block, + # run checks here. + if not self.SeenOpenBrace(): + self.stack[-1].CheckBegin(filename, clean_lines, linenum, error) + + # Update access control if we are inside a class/struct + if self.stack and isinstance(self.stack[-1], _ClassInfo): + classinfo = self.stack[-1] + access_match = Match( + r'^(.*)\b(public|private|protected|signals)(\s+(?:slots\s*)?)?' + r':(?:[^:]|$)', + line) + if access_match: + classinfo.access = access_match.group(2) + + # Check that access keywords are indented +1 space. Skip this + # check if the keywords are not preceded by whitespaces. + indent = access_match.group(1) + if (len(indent) != classinfo.class_indent + 1 and + Match(r'^\s*$', indent)): + if classinfo.is_struct: + parent = 'struct ' + classinfo.name + else: + parent = 'class ' + classinfo.name + slots = '' + if access_match.group(3): + slots = access_match.group(3) + error(filename, linenum, 'whitespace/indent', 3, + '%s%s: should be indented +1 space inside %s' % ( + access_match.group(2), slots, parent)) + + # Consume braces or semicolons from what's left of the line + while True: + # Match first brace, semicolon, or closed parenthesis. + matched = Match(r'^[^{;)}]*([{;)}])(.*)$', line) + if not matched: + break + + token = matched.group(1) + if token == '{': + # If namespace or class hasn't seen a opening brace yet, mark + # namespace/class head as complete. Push a new block onto the + # stack otherwise. + if not self.SeenOpenBrace(): + self.stack[-1].seen_open_brace = True + elif Match(r'^extern\s*"[^"]*"\s*\{', line): + self.stack.append(_ExternCInfo(linenum)) + else: + self.stack.append(_BlockInfo(linenum, True)) + if _MATCH_ASM.match(line): + self.stack[-1].inline_asm = _BLOCK_ASM + + elif token == ';' or token == ')': + # If we haven't seen an opening brace yet, but we already saw + # a semicolon, this is probably a forward declaration. Pop + # the stack for these. + # + # Similarly, if we haven't seen an opening brace yet, but we + # already saw a closing parenthesis, then these are probably + # function arguments with extra "class" or "struct" keywords. + # Also pop these stack for these. + if not self.SeenOpenBrace(): + self.stack.pop() + else: # token == '}' + # Perform end of block checks and pop the stack. + if self.stack: + self.stack[-1].CheckEnd(filename, clean_lines, linenum, error) + self.stack.pop() + line = matched.group(2) + + def InnermostClass(self): + """Get class info on the top of the stack. + + Returns: + A _ClassInfo object if we are inside a class, or None otherwise. + """ + for i in range(len(self.stack), 0, -1): + classinfo = self.stack[i - 1] + if isinstance(classinfo, _ClassInfo): + return classinfo + return None + + def CheckCompletedBlocks(self, filename, error): + """Checks that all classes and namespaces have been completely parsed. + + Call this when all lines in a file have been processed. + Args: + filename: The name of the current file. + error: The function to call with any errors found. + """ + # Note: This test can result in false positives if #ifdef constructs + # get in the way of brace matching. See the testBuildClass test in + # cpplint_unittest.py for an example of this. + for obj in self.stack: + if isinstance(obj, _ClassInfo): + error(filename, obj.starting_linenum, 'build/class', 5, + 'Failed to find complete declaration of class %s' % + obj.name) + elif isinstance(obj, _NamespaceInfo): + error(filename, obj.starting_linenum, 'build/namespaces', 5, + 'Failed to find complete declaration of namespace %s' % + obj.name) + + +def CheckForNonStandardConstructs(filename, clean_lines, linenum, + nesting_state, error): + r"""Logs an error if we see certain non-ANSI constructs ignored by gcc-2. + + Complain about several constructs which gcc-2 accepts, but which are + not standard C++. Warning about these in lint is one way to ease the + transition to new compilers. + - put storage class first (e.g. "static const" instead of "const static"). + - "%lld" instead of %qd" in printf-type functions. + - "%1$d" is non-standard in printf-type functions. + - "\%" is an undefined character escape sequence. + - text after #endif is not allowed. + - invalid inner-style forward declaration. + - >? and ?= and )\?=?\s*(\w+|[+-]?\d+)(\.\d*)?', + line): + error(filename, linenum, 'build/deprecated', 3, + '>? and ))?' + # r'\s*const\s*' + type_name + '\s*&\s*\w+\s*;' + error(filename, linenum, 'runtime/member_string_references', 2, + 'const string& members are dangerous. It is much better to use ' + 'alternatives, such as pointers or simple constants.') + + # Everything else in this function operates on class declarations. + # Return early if the top of the nesting stack is not a class, or if + # the class head is not completed yet. + classinfo = nesting_state.InnermostClass() + if not classinfo or not classinfo.seen_open_brace: + return + + # The class may have been declared with namespace or classname qualifiers. + # The constructor and destructor will not have those qualifiers. + base_classname = classinfo.name.split('::')[-1] + + # Look for single-argument constructors that aren't marked explicit. + # Technically a valid construct, but against style. + explicit_constructor_match = Match( + r'\s+(?:inline\s+)?(explicit\s+)?(?:inline\s+)?%s\s*' + r'\(((?:[^()]|\([^()]*\))*)\)' + % re.escape(base_classname), + line) + + if explicit_constructor_match: + is_marked_explicit = explicit_constructor_match.group(1) + + if not explicit_constructor_match.group(2): + constructor_args = [] + else: + constructor_args = explicit_constructor_match.group(2).split(',') + + # collapse arguments so that commas in template parameter lists and function + # argument parameter lists don't split arguments in two + i = 0 + while i < len(constructor_args): + constructor_arg = constructor_args[i] + while (constructor_arg.count('<') > constructor_arg.count('>') or + constructor_arg.count('(') > constructor_arg.count(')')): + constructor_arg += ',' + constructor_args[i + 1] + del constructor_args[i + 1] + constructor_args[i] = constructor_arg + i += 1 + + variadic_args = [arg for arg in constructor_args if '&&...' in arg] + defaulted_args = [arg for arg in constructor_args if '=' in arg] + noarg_constructor = (not constructor_args or # empty arg list + # 'void' arg specifier + (len(constructor_args) == 1 and + constructor_args[0].strip() == 'void')) + onearg_constructor = ((len(constructor_args) == 1 and # exactly one arg + not noarg_constructor) or + # all but at most one arg defaulted + (len(constructor_args) >= 1 and + not noarg_constructor and + len(defaulted_args) >= len(constructor_args) - 1) or + # variadic arguments with zero or one argument + (len(constructor_args) <= 2 and + len(variadic_args) >= 1)) + initializer_list_constructor = bool( + onearg_constructor and + Search(r'\bstd\s*::\s*initializer_list\b', constructor_args[0])) + copy_constructor = bool( + onearg_constructor and + Match(r'(const\s+)?%s(\s*<[^>]*>)?(\s+const)?\s*(?:<\w+>\s*)?&' + % re.escape(base_classname), constructor_args[0].strip())) + + if (not is_marked_explicit and + onearg_constructor and + not initializer_list_constructor and + not copy_constructor): + if defaulted_args or variadic_args: + error(filename, linenum, 'runtime/explicit', 5, + 'Constructors callable with one argument ' + 'should be marked explicit.') + else: + error(filename, linenum, 'runtime/explicit', 5, + 'Single-parameter constructors should be marked explicit.') + elif is_marked_explicit and not onearg_constructor: + if noarg_constructor: + error(filename, linenum, 'runtime/explicit', 5, + 'Zero-parameter constructors should not be marked explicit.') + + +def CheckSpacingForFunctionCall(filename, clean_lines, linenum, error): + """Checks for the correctness of various spacing around function calls. + + Args: + filename: The name of the current file. + clean_lines: A CleansedLines instance containing the file. + linenum: The number of the line to check. + error: The function to call with any errors found. + """ + line = clean_lines.elided[linenum] + + # Since function calls often occur inside if/for/while/switch + # expressions - which have their own, more liberal conventions - we + # first see if we should be looking inside such an expression for a + # function call, to which we can apply more strict standards. + fncall = line # if there's no control flow construct, look at whole line + for pattern in (r'\bif\s*\((.*)\)\s*{', + r'\bfor\s*\((.*)\)\s*{', + r'\bwhile\s*\((.*)\)\s*[{;]', + r'\bswitch\s*\((.*)\)\s*{'): + match = Search(pattern, line) + if match: + fncall = match.group(1) # look inside the parens for function calls + break + + # Except in if/for/while/switch, there should never be space + # immediately inside parens (eg "f( 3, 4 )"). We make an exception + # for nested parens ( (a+b) + c ). Likewise, there should never be + # a space before a ( when it's a function argument. I assume it's a + # function argument when the char before the whitespace is legal in + # a function name (alnum + _) and we're not starting a macro. Also ignore + # pointers and references to arrays and functions coz they're too tricky: + # we use a very simple way to recognize these: + # " (something)(maybe-something)" or + # " (something)(maybe-something," or + # " (something)[something]" + # Note that we assume the contents of [] to be short enough that + # they'll never need to wrap. + if ( # Ignore control structures. + not Search(r'\b(if|or|and|for|while|switch|return|new|delete|catch|sizeof)\b', + fncall) and + # Ignore pointers/references to functions. + not Search(r' \([^)]+\)\([^)]*(\)|,$)', fncall) and + # Ignore pointers/references to arrays. + not Search(r' \([^)]+\)\[[^\]]+\]', fncall)): + if Search(r'\w\s*\(\s(?!\s*\\$)', fncall): # a ( used for a fn call + error(filename, linenum, 'whitespace/parens', 4, + 'Extra space after ( in function call') + elif Search(r'\(\s+(?!(\s*\\)|\()', fncall): + error(filename, linenum, 'whitespace/parens', 2, + 'Extra space after (') + if (Search(r'\w\s+\(', fncall) and + not Search(r'_{0,2}asm_{0,2}\s+_{0,2}volatile_{0,2}\s+\(', fncall) and + not Search(r'#\s*define|typedef|using\s+\w+\s*=', fncall) and + not Search(r'\w\s+\((\w+::)*\*\w+\)\(', fncall) and + not Search(r'\bcase\s+\(', fncall)): + # TODO(unknown): Space after an operator function seem to be a common + # error, silence those for now by restricting them to highest verbosity. + if Search(r'\boperator_*\b', line): + error(filename, linenum, 'whitespace/parens', 0, + 'Extra space before ( in function call') + else: + error(filename, linenum, 'whitespace/parens', 4, + 'Extra space before ( in function call') + # If the ) is followed only by a newline or a { + newline, assume it's + # part of a control statement (if/while/etc), and don't complain + if Search(r'[^)]\s+\)\s*[^{\s]', fncall): + # If the closing parenthesis is preceded by only whitespaces, + # try to give a more descriptive error message. + if Search(r'^\s+\)', fncall): + error(filename, linenum, 'whitespace/parens', 2, + 'Closing ) should be moved to the previous line') + else: + error(filename, linenum, 'whitespace/parens', 2, + 'Extra space before )') + + +def IsBlankLine(line): + """Returns true if the given line is blank. + + We consider a line to be blank if the line is empty or consists of + only white spaces. + + Args: + line: A line of a string. + + Returns: + True, if the given line is blank. + """ + return not line or line.isspace() + + +def CheckForNamespaceIndentation(filename, nesting_state, clean_lines, line, + error): + is_namespace_indent_item = ( + len(nesting_state.stack) > 1 and + nesting_state.stack[-1].check_namespace_indentation and + isinstance(nesting_state.previous_stack_top, _NamespaceInfo) and + nesting_state.previous_stack_top == nesting_state.stack[-2]) + + if ShouldCheckNamespaceIndentation(nesting_state, is_namespace_indent_item, + clean_lines.elided, line): + CheckItemIndentationInNamespace(filename, clean_lines.elided, + line, error) + + +def CheckForFunctionLengths(filename, clean_lines, linenum, + function_state, error): + """Reports for long function bodies. + + For an overview why this is done, see: + https://google-styleguide.googlecode.com/svn/trunk/cppguide.xml#Write_Short_Functions + + Uses a simplistic algorithm assuming other style guidelines + (especially spacing) are followed. + Only checks unindented functions, so class members are unchecked. + Trivial bodies are unchecked, so constructors with huge initializer lists + may be missed. + Blank/comment lines are not counted so as to avoid encouraging the removal + of vertical space and comments just to get through a lint check. + NOLINT *on the last line of a function* disables this check. + + Args: + filename: The name of the current file. + clean_lines: A CleansedLines instance containing the file. + linenum: The number of the line to check. + function_state: Current function name and lines in body so far. + error: The function to call with any errors found. + """ + lines = clean_lines.lines + line = lines[linenum] + joined_line = '' + + starting_func = False + regexp = r'(\w(\w|::|\*|\&|\s)*)\(' # decls * & space::name( ... + match_result = Match(regexp, line) + if match_result: + # If the name is all caps and underscores, figure it's a macro and + # ignore it, unless it's TEST or TEST_F. + function_name = match_result.group(1).split()[-1] + if function_name == 'TEST' or function_name == 'TEST_F' or ( + not Match(r'[A-Z_]+$', function_name)): + starting_func = True + + if starting_func: + body_found = False + for start_linenum in range(linenum, clean_lines.NumLines()): + start_line = lines[start_linenum] + joined_line += ' ' + start_line.lstrip() + if Search(r'(;|})', start_line): # Declarations and trivial functions + body_found = True + break # ... ignore + elif Search(r'{', start_line): + body_found = True + function = Search(r'((\w|:)*)\(', line).group(1) + if Match(r'TEST', function): # Handle TEST... macros + parameter_regexp = Search(r'(\(.*\))', joined_line) + if parameter_regexp: # Ignore bad syntax + function += parameter_regexp.group(1) + else: + function += '()' + function_state.Begin(function) + break + if not body_found: + # No body for the function (or evidence of a non-function) was found. + error(filename, linenum, 'readability/fn_size', 5, + 'Lint failed to find start of function body.') + elif Match(r'^\}\s*$', line): # function end + function_state.Check(error, filename, linenum) + function_state.End() + elif not Match(r'^\s*$', line): + function_state.Count() # Count non-blank/non-comment lines. + + +_RE_PATTERN_TODO = re.compile(r'^//(\s*)TODO(\(.+?\))?:?(\s|$)?') + + +def CheckComment(line, filename, linenum, next_line_start, error): + """Checks for common mistakes in comments. + + Args: + line: The line in question. + filename: The name of the current file. + linenum: The number of the line to check. + next_line_start: The first non-whitespace column of the next line. + error: The function to call with any errors found. + """ + commentpos = line.find('//') + if commentpos != -1: + # Check if the // may be in quotes. If so, ignore it + if re.sub(r'\\.', '', line[0:commentpos]).count('"') % 2 == 0: + # Allow one space for new scopes, two spaces otherwise: + if (not (Match(r'^.*{ *//', line) and next_line_start == commentpos) and + ((commentpos >= 1 and + line[commentpos-1] not in string.whitespace) or + (commentpos >= 2 and + line[commentpos-2] not in string.whitespace))): + error(filename, linenum, 'whitespace/comments', 2, + 'At least two spaces is best between code and comments') + + # Checks for common mistakes in TODO comments. + comment = line[commentpos:] + match = _RE_PATTERN_TODO.match(comment) + if match: + # One whitespace is correct; zero whitespace is handled elsewhere. + leading_whitespace = match.group(1) + if len(leading_whitespace) > 1: + error(filename, linenum, 'whitespace/todo', 2, + 'Too many spaces before TODO') + + username = match.group(2) + if not username: + error(filename, linenum, 'readability/todo', 2, + 'Missing username in TODO; it should look like ' + '"// TODO(my_username): Stuff."') + + middle_whitespace = match.group(3) + # Comparisons made explicit for correctness -- pylint: disable=g-explicit-bool-comparison + if middle_whitespace != ' ' and middle_whitespace != '': + error(filename, linenum, 'whitespace/todo', 2, + 'TODO(my_username) should be followed by a space') + + # If the comment contains an alphanumeric character, there + # should be a space somewhere between it and the // unless + # it's a /// or //! Doxygen comment. + if (Match(r'//[^ ]*\w', comment) and + not Match(r'(///|//\!)(\s+|$)', comment)): + error(filename, linenum, 'whitespace/comments', 4, + 'Should have a space between // and comment') + + +def CheckAccess(filename, clean_lines, linenum, nesting_state, error): + """Checks for improper use of DISALLOW* macros. + + Args: + filename: The name of the current file. + clean_lines: A CleansedLines instance containing the file. + linenum: The number of the line to check. + nesting_state: A NestingState instance which maintains information about + the current stack of nested blocks being parsed. + error: The function to call with any errors found. + """ + line = clean_lines.elided[linenum] # get rid of comments and strings + + matched = Match((r'\s*(DISALLOW_COPY_AND_ASSIGN|' + r'DISALLOW_IMPLICIT_CONSTRUCTORS)'), line) + if not matched: + return + if nesting_state.stack and isinstance(nesting_state.stack[-1], _ClassInfo): + if nesting_state.stack[-1].access != 'private': + error(filename, linenum, 'readability/constructors', 3, + '%s must be in the private: section' % matched.group(1)) + + else: + # Found DISALLOW* macro outside a class declaration, or perhaps it + # was used inside a function when it should have been part of the + # class declaration. We could issue a warning here, but it + # probably resulted in a compiler error already. + pass + + +def CheckSpacing(filename, clean_lines, linenum, nesting_state, error): + """Checks for the correctness of various spacing issues in the code. + + Things we check for: spaces around operators, spaces after + if/for/while/switch, no spaces around parens in function calls, two + spaces between code and comment, don't start a block with a blank + line, don't end a function with a blank line, don't add a blank line + after public/protected/private, don't have too many blank lines in a row. + + Args: + filename: The name of the current file. + clean_lines: A CleansedLines instance containing the file. + linenum: The number of the line to check. + nesting_state: A NestingState instance which maintains information about + the current stack of nested blocks being parsed. + error: The function to call with any errors found. + """ + + # Don't use "elided" lines here, otherwise we can't check commented lines. + # Don't want to use "raw" either, because we don't want to check inside C++11 + # raw strings, + raw = clean_lines.lines_without_raw_strings + line = raw[linenum] + + # Before nixing comments, check if the line is blank for no good + # reason. This includes the first line after a block is opened, and + # blank lines at the end of a function (ie, right before a line like '}' + # + # Skip all the blank line checks if we are immediately inside a + # namespace body. In other words, don't issue blank line warnings + # for this block: + # namespace { + # + # } + # + # A warning about missing end of namespace comments will be issued instead. + # + # Also skip blank line checks for 'extern "C"' blocks, which are formatted + # like namespaces. + if (IsBlankLine(line) and + not nesting_state.InNamespaceBody() and + not nesting_state.InExternC()): + elided = clean_lines.elided + prev_line = elided[linenum - 1] + prevbrace = prev_line.rfind('{') + # TODO(unknown): Don't complain if line before blank line, and line after, + # both start with alnums and are indented the same amount. + # This ignores whitespace at the start of a namespace block + # because those are not usually indented. + if prevbrace != -1 and prev_line[prevbrace:].find('}') == -1: + # OK, we have a blank line at the start of a code block. Before we + # complain, we check if it is an exception to the rule: The previous + # non-empty line has the parameters of a function header that are indented + # 4 spaces (because they did not fit in a 80 column line when placed on + # the same line as the function name). We also check for the case where + # the previous line is indented 6 spaces, which may happen when the + # initializers of a constructor do not fit into a 80 column line. + exception = False + if Match(r' {6}\w', prev_line): # Initializer list? + # We are looking for the opening column of initializer list, which + # should be indented 4 spaces to cause 6 space indentation afterwards. + search_position = linenum-2 + while (search_position >= 0 + and Match(r' {6}\w', elided[search_position])): + search_position -= 1 + exception = (search_position >= 0 + and elided[search_position][:5] == ' :') + else: + # Search for the function arguments or an initializer list. We use a + # simple heuristic here: If the line is indented 4 spaces; and we have a + # closing paren, without the opening paren, followed by an opening brace + # or colon (for initializer lists) we assume that it is the last line of + # a function header. If we have a colon indented 4 spaces, it is an + # initializer list. + exception = (Match(r' {4}\w[^\(]*\)\s*(const\s*)?(\{\s*$|:)', + prev_line) + or Match(r' {4}:', prev_line)) + + if not exception: + error(filename, linenum, 'whitespace/blank_line', 2, + 'Redundant blank line at the start of a code block ' + 'should be deleted.') + # Ignore blank lines at the end of a block in a long if-else + # chain, like this: + # if (condition1) { + # // Something followed by a blank line + # + # } else if (condition2) { + # // Something else + # } + if linenum + 1 < clean_lines.NumLines(): + next_line = raw[linenum + 1] + if (next_line + and Match(r'\s*}', next_line) + and next_line.find('} else ') == -1): + error(filename, linenum, 'whitespace/blank_line', 3, + 'Redundant blank line at the end of a code block ' + 'should be deleted.') + + matched = Match(r'\s*(public|protected|private):', prev_line) + if matched: + error(filename, linenum, 'whitespace/blank_line', 3, + 'Do not leave a blank line after "%s:"' % matched.group(1)) + + # Next, check comments + next_line_start = 0 + if linenum + 1 < clean_lines.NumLines(): + next_line = raw[linenum + 1] + next_line_start = len(next_line) - len(next_line.lstrip()) + CheckComment(line, filename, linenum, next_line_start, error) + + # get rid of comments and strings + line = clean_lines.elided[linenum] + + # You shouldn't have spaces before your brackets, except maybe after + # 'delete []' or 'return []() {};' + if Search(r'\w\s+\[', line) and not Search(r'(?:delete|return)\s+\[', line): + error(filename, linenum, 'whitespace/braces', 5, + 'Extra space before [') + + # In range-based for, we wanted spaces before and after the colon, but + # not around "::" tokens that might appear. + if (Search(r'for *\(.*[^:]:[^: ]', line) or + Search(r'for *\(.*[^: ]:[^:]', line)): + error(filename, linenum, 'whitespace/forcolon', 2, + 'Missing space around colon in range-based for loop') + + +def CheckOperatorSpacing(filename, clean_lines, linenum, error): + """Checks for horizontal spacing around operators. + + Args: + filename: The name of the current file. + clean_lines: A CleansedLines instance containing the file. + linenum: The number of the line to check. + error: The function to call with any errors found. + """ + line = clean_lines.elided[linenum] + + # Don't try to do spacing checks for operator methods. Do this by + # replacing the troublesome characters with something else, + # preserving column position for all other characters. + # + # The replacement is done repeatedly to avoid false positives from + # operators that call operators. + while True: + match = Match(r'^(.*\boperator\b)(\S+)(\s*\(.*)$', line) + if match: + line = match.group(1) + ('_' * len(match.group(2))) + match.group(3) + else: + break + + # We allow no-spaces around = within an if: "if ( (a=Foo()) == 0 )". + # Otherwise not. Note we only check for non-spaces on *both* sides; + # sometimes people put non-spaces on one side when aligning ='s among + # many lines (not that this is behavior that I approve of...) + if ((Search(r'[\w.]=', line) or + Search(r'=[\w.]', line)) + and not Search(r'\b(if|while|for) ', line) + # Operators taken from [lex.operators] in C++11 standard. + and not Search(r'(>=|<=|==|!=|&=|\^=|\|=|\+=|\*=|\/=|\%=)', line) + and not Search(r'operator=', line)): + error(filename, linenum, 'whitespace/operators', 4, + 'Missing spaces around =') + + # It's ok not to have spaces around binary operators like + - * /, but if + # there's too little whitespace, we get concerned. It's hard to tell, + # though, so we punt on this one for now. TODO. + + # You should always have whitespace around binary operators. + # + # Check <= and >= first to avoid false positives with < and >, then + # check non-include lines for spacing around < and >. + # + # If the operator is followed by a comma, assume it's be used in a + # macro context and don't do any checks. This avoids false + # positives. + # + # Note that && is not included here. This is because there are too + # many false positives due to RValue references. + match = Search(r'[^<>=!\s](==|!=|<=|>=|\|\|)[^<>=!\s,;\)]', line) + if match: + error(filename, linenum, 'whitespace/operators', 3, + 'Missing spaces around %s' % match.group(1)) + elif not Match(r'#.*include', line): + # Look for < that is not surrounded by spaces. This is only + # triggered if both sides are missing spaces, even though + # technically should should flag if at least one side is missing a + # space. This is done to avoid some false positives with shifts. + match = Match(r'^(.*[^\s<])<[^\s=<,]', line) + if match: + (_, _, end_pos) = CloseExpression( + clean_lines, linenum, len(match.group(1))) + if end_pos <= -1: + error(filename, linenum, 'whitespace/operators', 3, + 'Missing spaces around <') + + # Look for > that is not surrounded by spaces. Similar to the + # above, we only trigger if both sides are missing spaces to avoid + # false positives with shifts. + match = Match(r'^(.*[^-\s>])>[^\s=>,]', line) + if match: + (_, _, start_pos) = ReverseCloseExpression( + clean_lines, linenum, len(match.group(1))) + if start_pos <= -1: + error(filename, linenum, 'whitespace/operators', 3, + 'Missing spaces around >') + + # We allow no-spaces around << when used like this: 10<<20, but + # not otherwise (particularly, not when used as streams) + # + # We also allow operators following an opening parenthesis, since + # those tend to be macros that deal with operators. + match = Search(r'(operator|[^\s(<])(?:L|UL|LL|ULL|l|ul|ll|ull)?<<([^\s,=<])', line) + if (match and not (match.group(1).isdigit() and match.group(2).isdigit()) and + not (match.group(1) == 'operator' and match.group(2) == ';')): + error(filename, linenum, 'whitespace/operators', 3, + 'Missing spaces around <<') + + # We allow no-spaces around >> for almost anything. This is because + # C++11 allows ">>" to close nested templates, which accounts for + # most cases when ">>" is not followed by a space. + # + # We still warn on ">>" followed by alpha character, because that is + # likely due to ">>" being used for right shifts, e.g.: + # value >> alpha + # + # When ">>" is used to close templates, the alphanumeric letter that + # follows would be part of an identifier, and there should still be + # a space separating the template type and the identifier. + # type> alpha + match = Search(r'>>[a-zA-Z_]', line) + if match: + error(filename, linenum, 'whitespace/operators', 3, + 'Missing spaces around >>') + + # There shouldn't be space around unary operators + match = Search(r'(!\s|~\s|[\s]--[\s;]|[\s]\+\+[\s;])', line) + if match: + error(filename, linenum, 'whitespace/operators', 4, + 'Extra space for operator %s' % match.group(1)) + + +def CheckParenthesisSpacing(filename, clean_lines, linenum, error): + """Checks for horizontal spacing around parentheses. + + Args: + filename: The name of the current file. + clean_lines: A CleansedLines instance containing the file. + linenum: The number of the line to check. + error: The function to call with any errors found. + """ + line = clean_lines.elided[linenum] + + # No spaces after an if, while, switch, or for + match = Search(r' (if\(|for\(|while\(|switch\()', line) + if match: + error(filename, linenum, 'whitespace/parens', 5, + 'Missing space before ( in %s' % match.group(1)) + + # For if/for/while/switch, the left and right parens should be + # consistent about how many spaces are inside the parens, and + # there should either be zero or one spaces inside the parens. + # We don't want: "if ( foo)" or "if ( foo )". + # Exception: "for ( ; foo; bar)" and "for (foo; bar; )" are allowed. + match = Search(r'\b(if|for|while|switch)\s*' + r'\(([ ]*)(.).*[^ ]+([ ]*)\)\s*{\s*$', + line) + if match: + if len(match.group(2)) != len(match.group(4)): + if not (match.group(3) == ';' and + len(match.group(2)) == 1 + len(match.group(4)) or + not match.group(2) and Search(r'\bfor\s*\(.*; \)', line)): + error(filename, linenum, 'whitespace/parens', 5, + 'Mismatching spaces inside () in %s' % match.group(1)) + if len(match.group(2)) not in [0, 1]: + error(filename, linenum, 'whitespace/parens', 5, + 'Should have zero or one spaces inside ( and ) in %s' % + match.group(1)) + + +def CheckCommaSpacing(filename, clean_lines, linenum, error): + """Checks for horizontal spacing near commas and semicolons. + + Args: + filename: The name of the current file. + clean_lines: A CleansedLines instance containing the file. + linenum: The number of the line to check. + error: The function to call with any errors found. + """ + raw = clean_lines.lines_without_raw_strings + line = clean_lines.elided[linenum] + + # You should always have a space after a comma (either as fn arg or operator) + # + # This does not apply when the non-space character following the + # comma is another comma, since the only time when that happens is + # for empty macro arguments. + # + # We run this check in two passes: first pass on elided lines to + # verify that lines contain missing whitespaces, second pass on raw + # lines to confirm that those missing whitespaces are not due to + # elided comments. + if (Search(r',[^,\s]', ReplaceAll(r'\boperator\s*,\s*\(', 'F(', line)) and + Search(r',[^,\s]', raw[linenum])): + error(filename, linenum, 'whitespace/comma', 3, + 'Missing space after ,') + + # You should always have a space after a semicolon + # except for few corner cases + # TODO(unknown): clarify if 'if (1) { return 1;}' is requires one more + # space after ; + if Search(r';[^\s};\\)/]', line): + error(filename, linenum, 'whitespace/semicolon', 3, + 'Missing space after ;') + + +def _IsType(clean_lines, nesting_state, expr): + """Check if expression looks like a type name, returns true if so. + + Args: + clean_lines: A CleansedLines instance containing the file. + nesting_state: A NestingState instance which maintains information about + the current stack of nested blocks being parsed. + expr: The expression to check. + Returns: + True, if token looks like a type. + """ + # Keep only the last token in the expression + last_word = Match(r'^.*(\b\S+)$', expr) + if last_word: + token = last_word.group(1) + else: + token = expr + + # Match native types and stdint types + if _TYPES.match(token): + return True + + # Try a bit harder to match templated types. Walk up the nesting + # stack until we find something that resembles a typename + # declaration for what we are looking for. + typename_pattern = (r'\b(?:typename|class|struct)\s+' + re.escape(token) + + r'\b') + block_index = len(nesting_state.stack) - 1 + while block_index >= 0: + if isinstance(nesting_state.stack[block_index], _NamespaceInfo): + return False + + # Found where the opening brace is. We want to scan from this + # line up to the beginning of the function, minus a few lines. + # template + # class C + # : public ... { // start scanning here + last_line = nesting_state.stack[block_index].starting_linenum + + next_block_start = 0 + if block_index > 0: + next_block_start = nesting_state.stack[block_index - 1].starting_linenum + first_line = last_line + while first_line >= next_block_start: + if clean_lines.elided[first_line].find('template') >= 0: + break + first_line -= 1 + if first_line < next_block_start: + # Didn't find any "template" keyword before reaching the next block, + # there are probably no template things to check for this block + block_index -= 1 + continue + + # Look for typename in the specified range + for i in xrange(first_line, last_line + 1, 1): + if Search(typename_pattern, clean_lines.elided[i]): + return True + block_index -= 1 + + return False + + +def CheckBracesSpacing(filename, clean_lines, linenum, nesting_state, error): + """Checks for horizontal spacing near commas. + + Args: + filename: The name of the current file. + clean_lines: A CleansedLines instance containing the file. + linenum: The number of the line to check. + nesting_state: A NestingState instance which maintains information about + the current stack of nested blocks being parsed. + error: The function to call with any errors found. + """ + line = clean_lines.elided[linenum] + + # Except after an opening paren, or after another opening brace (in case of + # an initializer list, for instance), you should have spaces before your + # braces when they are delimiting blocks, classes, namespaces etc. + # And since you should never have braces at the beginning of a line, + # this is an easy test. Except that braces used for initialization don't + # follow the same rule; we often don't want spaces before those. + match = Match(r'^(.*[^ ({>]){', line) + + if match: + # Try a bit harder to check for brace initialization. This + # happens in one of the following forms: + # Constructor() : initializer_list_{} { ... } + # Constructor{}.MemberFunction() + # Type variable{}; + # FunctionCall(type{}, ...); + # LastArgument(..., type{}); + # LOG(INFO) << type{} << " ..."; + # map_of_type[{...}] = ...; + # ternary = expr ? new type{} : nullptr; + # OuterTemplate{}> + # + # We check for the character following the closing brace, and + # silence the warning if it's one of those listed above, i.e. + # "{.;,)<>]:". + # + # To account for nested initializer list, we allow any number of + # closing braces up to "{;,)<". We can't simply silence the + # warning on first sight of closing brace, because that would + # cause false negatives for things that are not initializer lists. + # Silence this: But not this: + # Outer{ if (...) { + # Inner{...} if (...){ // Missing space before { + # }; } + # + # There is a false negative with this approach if people inserted + # spurious semicolons, e.g. "if (cond){};", but we will catch the + # spurious semicolon with a separate check. + leading_text = match.group(1) + (endline, endlinenum, endpos) = CloseExpression( + clean_lines, linenum, len(match.group(1))) + trailing_text = '' + if endpos > -1: + trailing_text = endline[endpos:] + for offset in xrange(endlinenum + 1, + min(endlinenum + 3, clean_lines.NumLines() - 1)): + trailing_text += clean_lines.elided[offset] + # We also suppress warnings for `uint64_t{expression}` etc., as the style + # guide recommends brace initialization for integral types to avoid + # overflow/truncation. + if (not Match(r'^[\s}]*[{.;,)<>\]:]', trailing_text) + and not _IsType(clean_lines, nesting_state, leading_text)): + error(filename, linenum, 'whitespace/braces', 5, + 'Missing space before {') + + # Make sure '} else {' has spaces. + if Search(r'}else', line): + error(filename, linenum, 'whitespace/braces', 5, + 'Missing space before else') + + # You shouldn't have a space before a semicolon at the end of the line. + # There's a special case for "for" since the style guide allows space before + # the semicolon there. + if Search(r':\s*;\s*$', line): + error(filename, linenum, 'whitespace/semicolon', 5, + 'Semicolon defining empty statement. Use {} instead.') + elif Search(r'^\s*;\s*$', line): + error(filename, linenum, 'whitespace/semicolon', 5, + 'Line contains only semicolon. If this should be an empty statement, ' + 'use {} instead.') + elif (Search(r'\s+;\s*$', line) and + not Search(r'\bfor\b', line)): + error(filename, linenum, 'whitespace/semicolon', 5, + 'Extra space before last semicolon. If this should be an empty ' + 'statement, use {} instead.') + + +def IsDecltype(clean_lines, linenum, column): + """Check if the token ending on (linenum, column) is decltype(). + + Args: + clean_lines: A CleansedLines instance containing the file. + linenum: the number of the line to check. + column: end column of the token to check. + Returns: + True if this token is decltype() expression, False otherwise. + """ + (text, _, start_col) = ReverseCloseExpression(clean_lines, linenum, column) + if start_col < 0: + return False + if Search(r'\bdecltype\s*$', text[0:start_col]): + return True + return False + +def CheckSectionSpacing(filename, clean_lines, class_info, linenum, error): + """Checks for additional blank line issues related to sections. + + Currently the only thing checked here is blank line before protected/private. + + Args: + filename: The name of the current file. + clean_lines: A CleansedLines instance containing the file. + class_info: A _ClassInfo objects. + linenum: The number of the line to check. + error: The function to call with any errors found. + """ + # Skip checks if the class is small, where small means 25 lines or less. + # 25 lines seems like a good cutoff since that's the usual height of + # terminals, and any class that can't fit in one screen can't really + # be considered "small". + # + # Also skip checks if we are on the first line. This accounts for + # classes that look like + # class Foo { public: ... }; + # + # If we didn't find the end of the class, last_line would be zero, + # and the check will be skipped by the first condition. + if (class_info.last_line - class_info.starting_linenum <= 24 or + linenum <= class_info.starting_linenum): + return + + matched = Match(r'\s*(public|protected|private):', clean_lines.lines[linenum]) + if matched: + # Issue warning if the line before public/protected/private was + # not a blank line, but don't do this if the previous line contains + # "class" or "struct". This can happen two ways: + # - We are at the beginning of the class. + # - We are forward-declaring an inner class that is semantically + # private, but needed to be public for implementation reasons. + # Also ignores cases where the previous line ends with a backslash as can be + # common when defining classes in C macros. + prev_line = clean_lines.lines[linenum - 1] + if (not IsBlankLine(prev_line) and + not Search(r'\b(class|struct)\b', prev_line) and + not Search(r'\\$', prev_line)): + # Try a bit harder to find the beginning of the class. This is to + # account for multi-line base-specifier lists, e.g.: + # class Derived + # : public Base { + end_class_head = class_info.starting_linenum + for i in range(class_info.starting_linenum, linenum): + if Search(r'\{\s*$', clean_lines.lines[i]): + end_class_head = i + break + if end_class_head < linenum - 1: + error(filename, linenum, 'whitespace/blank_line', 3, + '"%s:" should be preceded by a blank line' % matched.group(1)) + + +def GetPreviousNonBlankLine(clean_lines, linenum): + """Return the most recent non-blank line and its line number. + + Args: + clean_lines: A CleansedLines instance containing the file contents. + linenum: The number of the line to check. + + Returns: + A tuple with two elements. The first element is the contents of the last + non-blank line before the current line, or the empty string if this is the + first non-blank line. The second is the line number of that line, or -1 + if this is the first non-blank line. + """ + + prevlinenum = linenum - 1 + while prevlinenum >= 0: + prevline = clean_lines.elided[prevlinenum] + if not IsBlankLine(prevline): # if not a blank line... + return (prevline, prevlinenum) + prevlinenum -= 1 + return ('', -1) + + +def CheckBraces(filename, clean_lines, linenum, error): + """Looks for misplaced braces (e.g. at the end of line). + + Args: + filename: The name of the current file. + clean_lines: A CleansedLines instance containing the file. + linenum: The number of the line to check. + error: The function to call with any errors found. + """ + + line = clean_lines.elided[linenum] # get rid of comments and strings + + if Match(r'\s*{\s*$', line): + # We allow an open brace to start a line in the case where someone is using + # braces in a block to explicitly create a new scope, which is commonly used + # to control the lifetime of stack-allocated variables. Braces are also + # used for brace initializers inside function calls. We don't detect this + # perfectly: we just don't complain if the last non-whitespace character on + # the previous non-blank line is ',', ';', ':', '(', '{', or '}', or if the + # previous line starts a preprocessor block. We also allow a brace on the + # following line if it is part of an array initialization and would not fit + # within the 80 character limit of the preceding line. + prevline = GetPreviousNonBlankLine(clean_lines, linenum)[0] + if (not Search(r'[,;:}{(]\s*$', prevline) and + not Match(r'\s*#', prevline) and + not (GetLineWidth(prevline) > _line_length - 2 and '[]' in prevline)): + error(filename, linenum, 'whitespace/braces', 4, + '{ should almost always be at the end of the previous line') + + # An else clause should be on the same line as the preceding closing brace. + if Match(r'\s*else\b\s*(?:if\b|\{|$)', line): + prevline = GetPreviousNonBlankLine(clean_lines, linenum)[0] + if Match(r'\s*}\s*$', prevline): + error(filename, linenum, 'whitespace/newline', 4, + 'An else should appear on the same line as the preceding }') + + # If braces come on one side of an else, they should be on both. + # However, we have to worry about "else if" that spans multiple lines! + if Search(r'else if\s*\(', line): # could be multi-line if + brace_on_left = bool(Search(r'}\s*else if\s*\(', line)) + # find the ( after the if + pos = line.find('else if') + pos = line.find('(', pos) + if pos > 0: + (endline, _, endpos) = CloseExpression(clean_lines, linenum, pos) + brace_on_right = endline[endpos:].find('{') != -1 + if brace_on_left != brace_on_right: # must be brace after if + error(filename, linenum, 'readability/braces', 5, + 'If an else has a brace on one side, it should have it on both') + elif Search(r'}\s*else[^{]*$', line) or Match(r'[^}]*else\s*{', line): + error(filename, linenum, 'readability/braces', 5, + 'If an else has a brace on one side, it should have it on both') + + # Likewise, an else should never have the else clause on the same line + if Search(r'\belse [^\s{]', line) and not Search(r'\belse if\b', line): + error(filename, linenum, 'whitespace/newline', 4, + 'Else clause should never be on same line as else (use 2 lines)') + + # In the same way, a do/while should never be on one line + if Match(r'\s*do [^\s{]', line): + error(filename, linenum, 'whitespace/newline', 4, + 'do/while clauses should not be on a single line') + + # Check single-line if/else bodies. The style guide says 'curly braces are not + # required for single-line statements'. We additionally allow multi-line, + # single statements, but we reject anything with more than one semicolon in + # it. This means that the first semicolon after the if should be at the end of + # its line, and the line after that should have an indent level equal to or + # lower than the if. We also check for ambiguous if/else nesting without + # braces. + if_else_match = Search(r'\b(if\s*\(|else\b)', line) + if if_else_match and not Match(r'\s*#', line): + if_indent = GetIndentLevel(line) + endline, endlinenum, endpos = line, linenum, if_else_match.end() + if_match = Search(r'\bif\s*\(', line) + if if_match: + # This could be a multiline if condition, so find the end first. + pos = if_match.end() - 1 + (endline, endlinenum, endpos) = CloseExpression(clean_lines, linenum, pos) + # Check for an opening brace, either directly after the if or on the next + # line. If found, this isn't a single-statement conditional. + if (not Match(r'\s*{', endline[endpos:]) + and not (Match(r'\s*$', endline[endpos:]) + and endlinenum < (len(clean_lines.elided) - 1) + and Match(r'\s*{', clean_lines.elided[endlinenum + 1]))): + while (endlinenum < len(clean_lines.elided) + and ';' not in clean_lines.elided[endlinenum][endpos:]): + endlinenum += 1 + endpos = 0 + if endlinenum < len(clean_lines.elided): + endline = clean_lines.elided[endlinenum] + # We allow a mix of whitespace and closing braces (e.g. for one-liner + # methods) and a single \ after the semicolon (for macros) + endpos = endline.find(';') + if not Match(r';[\s}]*(\\?)$', endline[endpos:]): + # Semicolon isn't the last character, there's something trailing. + # Output a warning if the semicolon is not contained inside + # a lambda expression. + if not Match(r'^[^{};]*\[[^\[\]]*\][^{}]*\{[^{}]*\}\s*\)*[;,]\s*$', + endline): + error(filename, linenum, 'readability/braces', 4, + 'If/else bodies with multiple statements require braces') + elif endlinenum < len(clean_lines.elided) - 1: + # Make sure the next line is dedented + next_line = clean_lines.elided[endlinenum + 1] + next_indent = GetIndentLevel(next_line) + # With ambiguous nested if statements, this will error out on the + # if that *doesn't* match the else, regardless of whether it's the + # inner one or outer one. + if (if_match and Match(r'\s*else\b', next_line) + and next_indent != if_indent): + error(filename, linenum, 'readability/braces', 4, + 'Else clause should be indented at the same level as if. ' + 'Ambiguous nested if/else chains require braces.') + elif next_indent > if_indent: + error(filename, linenum, 'readability/braces', 4, + 'If/else bodies with multiple statements require braces') + + +def CheckTrailingSemicolon(filename, clean_lines, linenum, error): + """Looks for redundant trailing semicolon. + + Args: + filename: The name of the current file. + clean_lines: A CleansedLines instance containing the file. + linenum: The number of the line to check. + error: The function to call with any errors found. + """ + + line = clean_lines.elided[linenum] + + # Block bodies should not be followed by a semicolon. Due to C++11 + # brace initialization, there are more places where semicolons are + # required than not, so we use a whitelist approach to check these + # rather than a blacklist. These are the places where "};" should + # be replaced by just "}": + # 1. Some flavor of block following closing parenthesis: + # for (;;) {}; + # while (...) {}; + # switch (...) {}; + # Function(...) {}; + # if (...) {}; + # if (...) else if (...) {}; + # + # 2. else block: + # if (...) else {}; + # + # 3. const member function: + # Function(...) const {}; + # + # 4. Block following some statement: + # x = 42; + # {}; + # + # 5. Block at the beginning of a function: + # Function(...) { + # {}; + # } + # + # Note that naively checking for the preceding "{" will also match + # braces inside multi-dimensional arrays, but this is fine since + # that expression will not contain semicolons. + # + # 6. Block following another block: + # while (true) {} + # {}; + # + # 7. End of namespaces: + # namespace {}; + # + # These semicolons seems far more common than other kinds of + # redundant semicolons, possibly due to people converting classes + # to namespaces. For now we do not warn for this case. + # + # Try matching case 1 first. + match = Match(r'^(.*\)\s*)\{', line) + if match: + # Matched closing parenthesis (case 1). Check the token before the + # matching opening parenthesis, and don't warn if it looks like a + # macro. This avoids these false positives: + # - macro that defines a base class + # - multi-line macro that defines a base class + # - macro that defines the whole class-head + # + # But we still issue warnings for macros that we know are safe to + # warn, specifically: + # - TEST, TEST_F, TEST_P, MATCHER, MATCHER_P + # - TYPED_TEST + # - INTERFACE_DEF + # - EXCLUSIVE_LOCKS_REQUIRED, SHARED_LOCKS_REQUIRED, LOCKS_EXCLUDED: + # + # We implement a whitelist of safe macros instead of a blacklist of + # unsafe macros, even though the latter appears less frequently in + # google code and would have been easier to implement. This is because + # the downside for getting the whitelist wrong means some extra + # semicolons, while the downside for getting the blacklist wrong + # would result in compile errors. + # + # In addition to macros, we also don't want to warn on + # - Compound literals + # - Lambdas + # - alignas specifier with anonymous structs + # - decltype + closing_brace_pos = match.group(1).rfind(')') + opening_parenthesis = ReverseCloseExpression( + clean_lines, linenum, closing_brace_pos) + if opening_parenthesis[2] > -1: + line_prefix = opening_parenthesis[0][0:opening_parenthesis[2]] + macro = Search(r'\b([A-Z_][A-Z0-9_]*)\s*$', line_prefix) + func = Match(r'^(.*\])\s*$', line_prefix) + if ((macro and + macro.group(1) not in ( + 'TEST', 'TEST_F', 'MATCHER', 'MATCHER_P', 'TYPED_TEST', + 'EXCLUSIVE_LOCKS_REQUIRED', 'SHARED_LOCKS_REQUIRED', + 'LOCKS_EXCLUDED', 'INTERFACE_DEF')) or + (func and not Search(r'\boperator\s*\[\s*\]', func.group(1))) or + Search(r'\b(?:struct|union)\s+alignas\s*$', line_prefix) or + Search(r'\bdecltype$', line_prefix) or + Search(r'\s+=\s*$', line_prefix)): + match = None + if (match and + opening_parenthesis[1] > 1 and + Search(r'\]\s*$', clean_lines.elided[opening_parenthesis[1] - 1])): + # Multi-line lambda-expression + match = None + + else: + # Try matching cases 2-3. + match = Match(r'^(.*(?:else|\)\s*const)\s*)\{', line) + if not match: + # Try matching cases 4-6. These are always matched on separate lines. + # + # Note that we can't simply concatenate the previous line to the + # current line and do a single match, otherwise we may output + # duplicate warnings for the blank line case: + # if (cond) { + # // blank line + # } + prevline = GetPreviousNonBlankLine(clean_lines, linenum)[0] + if prevline and Search(r'[;{}]\s*$', prevline): + match = Match(r'^(\s*)\{', line) + + # Check matching closing brace + if match: + (endline, endlinenum, endpos) = CloseExpression( + clean_lines, linenum, len(match.group(1))) + if endpos > -1 and Match(r'^\s*;', endline[endpos:]): + # Current {} pair is eligible for semicolon check, and we have found + # the redundant semicolon, output warning here. + # + # Note: because we are scanning forward for opening braces, and + # outputting warnings for the matching closing brace, if there are + # nested blocks with trailing semicolons, we will get the error + # messages in reversed order. + + # We need to check the line forward for NOLINT + raw_lines = clean_lines.raw_lines + ParseNolintSuppressions(filename, raw_lines[endlinenum-1], endlinenum-1, + error) + ParseNolintSuppressions(filename, raw_lines[endlinenum], endlinenum, + error) + + error(filename, endlinenum, 'readability/braces', 4, + "You don't need a ; after a }") + + +def CheckEmptyBlockBody(filename, clean_lines, linenum, error): + """Look for empty loop/conditional body with only a single semicolon. + + Args: + filename: The name of the current file. + clean_lines: A CleansedLines instance containing the file. + linenum: The number of the line to check. + error: The function to call with any errors found. + """ + + # Search for loop keywords at the beginning of the line. Because only + # whitespaces are allowed before the keywords, this will also ignore most + # do-while-loops, since those lines should start with closing brace. + # + # We also check "if" blocks here, since an empty conditional block + # is likely an error. + line = clean_lines.elided[linenum] + matched = Match(r'\s*(for|while|if)\s*\(', line) + if matched: + # Find the end of the conditional expression. + (end_line, end_linenum, end_pos) = CloseExpression( + clean_lines, linenum, line.find('(')) + + # Output warning if what follows the condition expression is a semicolon. + # No warning for all other cases, including whitespace or newline, since we + # have a separate check for semicolons preceded by whitespace. + if end_pos >= 0 and Match(r';', end_line[end_pos:]): + if matched.group(1) == 'if': + error(filename, end_linenum, 'whitespace/empty_conditional_body', 5, + 'Empty conditional bodies should use {}') + else: + error(filename, end_linenum, 'whitespace/empty_loop_body', 5, + 'Empty loop bodies should use {} or continue') + + # Check for if statements that have completely empty bodies (no comments) + # and no else clauses. + if end_pos >= 0 and matched.group(1) == 'if': + # Find the position of the opening { for the if statement. + # Return without logging an error if it has no brackets. + opening_linenum = end_linenum + opening_line_fragment = end_line[end_pos:] + # Loop until EOF or find anything that's not whitespace or opening {. + while not Search(r'^\s*\{', opening_line_fragment): + if Search(r'^(?!\s*$)', opening_line_fragment): + # Conditional has no brackets. + return + opening_linenum += 1 + if opening_linenum == len(clean_lines.elided): + # Couldn't find conditional's opening { or any code before EOF. + return + opening_line_fragment = clean_lines.elided[opening_linenum] + # Set opening_line (opening_line_fragment may not be entire opening line). + opening_line = clean_lines.elided[opening_linenum] + + # Find the position of the closing }. + opening_pos = opening_line_fragment.find('{') + if opening_linenum == end_linenum: + # We need to make opening_pos relative to the start of the entire line. + opening_pos += end_pos + (closing_line, closing_linenum, closing_pos) = CloseExpression( + clean_lines, opening_linenum, opening_pos) + if closing_pos < 0: + return + + # Now construct the body of the conditional. This consists of the portion + # of the opening line after the {, all lines until the closing line, + # and the portion of the closing line before the }. + if (clean_lines.raw_lines[opening_linenum] != + CleanseComments(clean_lines.raw_lines[opening_linenum])): + # Opening line ends with a comment, so conditional isn't empty. + return + if closing_linenum > opening_linenum: + # Opening line after the {. Ignore comments here since we checked above. + bodylist = list(opening_line[opening_pos+1:]) + # All lines until closing line, excluding closing line, with comments. + bodylist.extend(clean_lines.raw_lines[opening_linenum+1:closing_linenum]) + # Closing line before the }. Won't (and can't) have comments. + bodylist.append(clean_lines.elided[closing_linenum][:closing_pos-1]) + body = '\n'.join(bodylist) + else: + # If statement has brackets and fits on a single line. + body = opening_line[opening_pos+1:closing_pos-1] + + # Check if the body is empty + if not _EMPTY_CONDITIONAL_BODY_PATTERN.search(body): + return + # The body is empty. Now make sure there's not an else clause. + current_linenum = closing_linenum + current_line_fragment = closing_line[closing_pos:] + # Loop until EOF or find anything that's not whitespace or else clause. + while Search(r'^\s*$|^(?=\s*else)', current_line_fragment): + if Search(r'^(?=\s*else)', current_line_fragment): + # Found an else clause, so don't log an error. + return + current_linenum += 1 + if current_linenum == len(clean_lines.elided): + break + current_line_fragment = clean_lines.elided[current_linenum] + + # The body is empty and there's no else clause until EOF or other code. + error(filename, end_linenum, 'whitespace/empty_if_body', 4, + ('If statement had no body and no else clause')) + + +def FindCheckMacro(line): + """Find a replaceable CHECK-like macro. + + Args: + line: line to search on. + Returns: + (macro name, start position), or (None, -1) if no replaceable + macro is found. + """ + for macro in _CHECK_MACROS: + i = line.find(macro) + if i >= 0: + # Find opening parenthesis. Do a regular expression match here + # to make sure that we are matching the expected CHECK macro, as + # opposed to some other macro that happens to contain the CHECK + # substring. + matched = Match(r'^(.*\b' + macro + r'\s*)\(', line) + if not matched: + continue + return (macro, len(matched.group(1))) + return (None, -1) + + +def CheckCheck(filename, clean_lines, linenum, error): + """Checks the use of CHECK and EXPECT macros. + + Args: + filename: The name of the current file. + clean_lines: A CleansedLines instance containing the file. + linenum: The number of the line to check. + error: The function to call with any errors found. + """ + + # Decide the set of replacement macros that should be suggested + lines = clean_lines.elided + (check_macro, start_pos) = FindCheckMacro(lines[linenum]) + if not check_macro: + return + + # Find end of the boolean expression by matching parentheses + (last_line, end_line, end_pos) = CloseExpression( + clean_lines, linenum, start_pos) + if end_pos < 0: + return + + # If the check macro is followed by something other than a + # semicolon, assume users will log their own custom error messages + # and don't suggest any replacements. + if not Match(r'\s*;', last_line[end_pos:]): + return + + if linenum == end_line: + expression = lines[linenum][start_pos + 1:end_pos - 1] + else: + expression = lines[linenum][start_pos + 1:] + for i in xrange(linenum + 1, end_line): + expression += lines[i] + expression += last_line[0:end_pos - 1] + + # Parse expression so that we can take parentheses into account. + # This avoids false positives for inputs like "CHECK((a < 4) == b)", + # which is not replaceable by CHECK_LE. + lhs = '' + rhs = '' + operator = None + while expression: + matched = Match(r'^\s*(<<|<<=|>>|>>=|->\*|->|&&|\|\||' + r'==|!=|>=|>|<=|<|\()(.*)$', expression) + if matched: + token = matched.group(1) + if token == '(': + # Parenthesized operand + expression = matched.group(2) + (end, _) = FindEndOfExpressionInLine(expression, 0, ['(']) + if end < 0: + return # Unmatched parenthesis + lhs += '(' + expression[0:end] + expression = expression[end:] + elif token in ('&&', '||'): + # Logical and/or operators. This means the expression + # contains more than one term, for example: + # CHECK(42 < a && a < b); + # + # These are not replaceable with CHECK_LE, so bail out early. + return + elif token in ('<<', '<<=', '>>', '>>=', '->*', '->'): + # Non-relational operator + lhs += token + expression = matched.group(2) + else: + # Relational operator + operator = token + rhs = matched.group(2) + break + else: + # Unparenthesized operand. Instead of appending to lhs one character + # at a time, we do another regular expression match to consume several + # characters at once if possible. Trivial benchmark shows that this + # is more efficient when the operands are longer than a single + # character, which is generally the case. + matched = Match(r'^([^-=!<>()&|]+)(.*)$', expression) + if not matched: + matched = Match(r'^(\s*\S)(.*)$', expression) + if not matched: + break + lhs += matched.group(1) + expression = matched.group(2) + + # Only apply checks if we got all parts of the boolean expression + if not (lhs and operator and rhs): + return + + # Check that rhs do not contain logical operators. We already know + # that lhs is fine since the loop above parses out && and ||. + if rhs.find('&&') > -1 or rhs.find('||') > -1: + return + + # At least one of the operands must be a constant literal. This is + # to avoid suggesting replacements for unprintable things like + # CHECK(variable != iterator) + # + # The following pattern matches decimal, hex integers, strings, and + # characters (in that order). + lhs = lhs.strip() + rhs = rhs.strip() + match_constant = r'^([-+]?(\d+|0[xX][0-9a-fA-F]+)[lLuU]{0,3}|".*"|\'.*\')$' + if Match(match_constant, lhs) or Match(match_constant, rhs): + # Note: since we know both lhs and rhs, we can provide a more + # descriptive error message like: + # Consider using CHECK_EQ(x, 42) instead of CHECK(x == 42) + # Instead of: + # Consider using CHECK_EQ instead of CHECK(a == b) + # + # We are still keeping the less descriptive message because if lhs + # or rhs gets long, the error message might become unreadable. + error(filename, linenum, 'readability/check', 2, + 'Consider using %s instead of %s(a %s b)' % ( + _CHECK_REPLACEMENT[check_macro][operator], + check_macro, operator)) + + +def CheckAltTokens(filename, clean_lines, linenum, error): + """Check alternative keywords being used in boolean expressions. + + Args: + filename: The name of the current file. + clean_lines: A CleansedLines instance containing the file. + linenum: The number of the line to check. + error: The function to call with any errors found. + """ + line = clean_lines.elided[linenum] + + # Avoid preprocessor lines + if Match(r'^\s*#', line): + return + + # Last ditch effort to avoid multi-line comments. This will not help + # if the comment started before the current line or ended after the + # current line, but it catches most of the false positives. At least, + # it provides a way to workaround this warning for people who use + # multi-line comments in preprocessor macros. + # + # TODO(unknown): remove this once cpplint has better support for + # multi-line comments. + if line.find('/*') >= 0 or line.find('*/') >= 0: + return + + for match in _ALT_TOKEN_REPLACEMENT_PATTERN.finditer(line): + error(filename, linenum, 'readability/alt_tokens', 2, + 'Use operator %s instead of %s' % ( + _ALT_TOKEN_REPLACEMENT[match.group(1)], match.group(1))) + + +def GetLineWidth(line): + """Determines the width of the line in column positions. + + Args: + line: A string, which may be a Unicode string. + + Returns: + The width of the line in column positions, accounting for Unicode + combining characters and wide characters. + """ + if isinstance(line, unicode): + width = 0 + for uc in unicodedata.normalize('NFC', line): + if unicodedata.east_asian_width(uc) in ('W', 'F'): + width += 2 + elif not unicodedata.combining(uc): + width += 1 + return width + else: + return len(line) + + +def CheckStyle(filename, clean_lines, linenum, file_extension, nesting_state, + error): + """Checks rules from the 'C++ style rules' section of cppguide.html. + + Most of these rules are hard to test (naming, comment style), but we + do what we can. In particular we check for 2-space indents, line lengths, + tab usage, spaces inside code, etc. + + Args: + filename: The name of the current file. + clean_lines: A CleansedLines instance containing the file. + linenum: The number of the line to check. + file_extension: The extension (without the dot) of the filename. + nesting_state: A NestingState instance which maintains information about + the current stack of nested blocks being parsed. + error: The function to call with any errors found. + """ + + # Don't use "elided" lines here, otherwise we can't check commented lines. + # Don't want to use "raw" either, because we don't want to check inside C++11 + # raw strings, + raw_lines = clean_lines.lines_without_raw_strings + line = raw_lines[linenum] + prev = raw_lines[linenum - 1] if linenum > 0 else '' + + if line.find('\t') != -1: + error(filename, linenum, 'whitespace/tab', 1, + 'Tab found; better to use spaces') + + # One or three blank spaces at the beginning of the line is weird; it's + # hard to reconcile that with 2-space indents. + # NOTE: here are the conditions rob pike used for his tests. Mine aren't + # as sophisticated, but it may be worth becoming so: RLENGTH==initial_spaces + # if(RLENGTH > 20) complain = 0; + # if(match($0, " +(error|private|public|protected):")) complain = 0; + # if(match(prev, "&& *$")) complain = 0; + # if(match(prev, "\\|\\| *$")) complain = 0; + # if(match(prev, "[\",=><] *$")) complain = 0; + # if(match($0, " <<")) complain = 0; + # if(match(prev, " +for \\(")) complain = 0; + # if(prevodd && match(prevprev, " +for \\(")) complain = 0; + scope_or_label_pattern = r'\s*\w+\s*:\s*\\?$' + classinfo = nesting_state.InnermostClass() + initial_spaces = 0 + cleansed_line = clean_lines.elided[linenum] + while initial_spaces < len(line) and line[initial_spaces] == ' ': + initial_spaces += 1 + # There are certain situations we allow one space, notably for + # section labels, and also lines containing multi-line raw strings. + # We also don't check for lines that look like continuation lines + # (of lines ending in double quotes, commas, equals, or angle brackets) + # because the rules for how to indent those are non-trivial. + if (not Search(r'[",=><] *$', prev) and + (initial_spaces == 1 or initial_spaces == 3) and + not Match(scope_or_label_pattern, cleansed_line) and + not (clean_lines.raw_lines[linenum] != line and + Match(r'^\s*""', line))): + error(filename, linenum, 'whitespace/indent', 3, + 'Weird number of spaces at line-start. ' + 'Are you using a 2-space indent?') + + if line and line[-1].isspace(): + error(filename, linenum, 'whitespace/end_of_line', 4, + 'Line ends in whitespace. Consider deleting these extra spaces.') + + # Check if the line is a header guard. + is_header_guard = False + if file_extension in GetHeaderExtensions(): + cppvar = GetHeaderGuardCPPVariable(filename) + if (line.startswith('#ifndef %s' % cppvar) or + line.startswith('#define %s' % cppvar) or + line.startswith('#endif // %s' % cppvar)): + is_header_guard = True + # #include lines and header guards can be long, since there's no clean way to + # split them. + # + # URLs can be long too. It's possible to split these, but it makes them + # harder to cut&paste. + # + # The "$Id:...$" comment may also get very long without it being the + # developers fault. + # + # Doxygen documentation copying can get pretty long when using an overloaded + # function declaration + if (not line.startswith('#include') and not is_header_guard and + not Match(r'^\s*//.*http(s?)://\S*$', line) and + not Match(r'^\s*//\s*[^\s]*$', line) and + not Match(r'^// \$Id:.*#[0-9]+ \$$', line) and + not Match(r'^\s*/// [@\\](copydoc|copydetails|copybrief) .*$', line)): + line_width = GetLineWidth(line) + if line_width > _line_length: + error(filename, linenum, 'whitespace/line_length', 2, + 'Lines should be <= %i characters long' % _line_length) + + if (cleansed_line.count(';') > 1 and + # allow simple single line lambdas + not Match(r'^[^{};]*\[[^\[\]]*\][^{}]*\{[^{}\n\r]*\}', + line) and + # for loops are allowed two ;'s (and may run over two lines). + cleansed_line.find('for') == -1 and + (GetPreviousNonBlankLine(clean_lines, linenum)[0].find('for') == -1 or + GetPreviousNonBlankLine(clean_lines, linenum)[0].find(';') != -1) and + # It's ok to have many commands in a switch case that fits in 1 line + not ((cleansed_line.find('case ') != -1 or + cleansed_line.find('default:') != -1) and + cleansed_line.find('break;') != -1)): + error(filename, linenum, 'whitespace/newline', 0, + 'More than one command on the same line') + + # Some more style checks + CheckBraces(filename, clean_lines, linenum, error) + CheckTrailingSemicolon(filename, clean_lines, linenum, error) + CheckEmptyBlockBody(filename, clean_lines, linenum, error) + CheckAccess(filename, clean_lines, linenum, nesting_state, error) + CheckSpacing(filename, clean_lines, linenum, nesting_state, error) + CheckOperatorSpacing(filename, clean_lines, linenum, error) + CheckParenthesisSpacing(filename, clean_lines, linenum, error) + CheckCommaSpacing(filename, clean_lines, linenum, error) + CheckBracesSpacing(filename, clean_lines, linenum, nesting_state, error) + CheckSpacingForFunctionCall(filename, clean_lines, linenum, error) + CheckCheck(filename, clean_lines, linenum, error) + CheckAltTokens(filename, clean_lines, linenum, error) + classinfo = nesting_state.InnermostClass() + if classinfo: + CheckSectionSpacing(filename, clean_lines, classinfo, linenum, error) + + +_RE_PATTERN_INCLUDE = re.compile(r'^\s*#\s*include\s*([<"])([^>"]*)[>"].*$') +# Matches the first component of a filename delimited by -s and _s. That is: +# _RE_FIRST_COMPONENT.match('foo').group(0) == 'foo' +# _RE_FIRST_COMPONENT.match('foo.cc').group(0) == 'foo' +# _RE_FIRST_COMPONENT.match('foo-bar_baz.cc').group(0) == 'foo' +# _RE_FIRST_COMPONENT.match('foo_bar-baz.cc').group(0) == 'foo' +_RE_FIRST_COMPONENT = re.compile(r'^[^-_.]+') + + +def _DropCommonSuffixes(filename): + """Drops common suffixes like _test.cc or -inl.h from filename. + + For example: + >>> _DropCommonSuffixes('foo/foo-inl.h') + 'foo/foo' + >>> _DropCommonSuffixes('foo/bar/foo.cc') + 'foo/bar/foo' + >>> _DropCommonSuffixes('foo/foo_internal.h') + 'foo/foo' + >>> _DropCommonSuffixes('foo/foo_unusualinternal.h') + 'foo/foo_unusualinternal' + + Args: + filename: The input filename. + + Returns: + The filename with the common suffix removed. + """ + for suffix in itertools.chain( + ('%s.%s' % (test_suffix.lstrip('_'), ext) + for test_suffix, ext in itertools.product(_test_suffixes, GetNonHeaderExtensions())), + ('%s.%s' % (suffix, ext) + for suffix, ext in itertools.product(['inl', 'imp', 'internal'], GetHeaderExtensions()))): + if (filename.endswith(suffix) and len(filename) > len(suffix) and + filename[-len(suffix) - 1] in ('-', '_')): + return filename[:-len(suffix) - 1] + return os.path.splitext(filename)[0] + + +def _ClassifyInclude(fileinfo, include, is_system): + """Figures out what kind of header 'include' is. + + Args: + fileinfo: The current file cpplint is running over. A FileInfo instance. + include: The path to a #included file. + is_system: True if the #include used <> rather than "". + + Returns: + One of the _XXX_HEADER constants. + + For example: + >>> _ClassifyInclude(FileInfo('foo/foo.cc'), 'stdio.h', True) + _C_SYS_HEADER + >>> _ClassifyInclude(FileInfo('foo/foo.cc'), 'string', True) + _CPP_SYS_HEADER + >>> _ClassifyInclude(FileInfo('foo/foo.cc'), 'foo/foo.h', False) + _LIKELY_MY_HEADER + >>> _ClassifyInclude(FileInfo('foo/foo_unknown_extension.cc'), + ... 'bar/foo_other_ext.h', False) + _POSSIBLE_MY_HEADER + >>> _ClassifyInclude(FileInfo('foo/foo.cc'), 'foo/bar.h', False) + _OTHER_HEADER + """ + # This is a list of all standard c++ header files, except + # those already checked for above. + is_cpp_h = include in _CPP_HEADERS + + # Headers with C++ extensions shouldn't be considered C system headers + if is_system and os.path.splitext(include)[1] in ['.hpp', '.hxx', '.h++']: + is_system = False + + if is_system: + if is_cpp_h: + return _CPP_SYS_HEADER + else: + return _C_SYS_HEADER + + # If the target file and the include we're checking share a + # basename when we drop common extensions, and the include + # lives in . , then it's likely to be owned by the target file. + target_dir, target_base = ( + os.path.split(_DropCommonSuffixes(fileinfo.RepositoryName()))) + include_dir, include_base = os.path.split(_DropCommonSuffixes(include)) + target_dir_pub = os.path.normpath(target_dir + '/../public') + target_dir_pub = target_dir_pub.replace('\\', '/') + if target_base == include_base and ( + include_dir == target_dir or + include_dir == target_dir_pub): + return _LIKELY_MY_HEADER + + # If the target and include share some initial basename + # component, it's possible the target is implementing the + # include, so it's allowed to be first, but we'll never + # complain if it's not there. + target_first_component = _RE_FIRST_COMPONENT.match(target_base) + include_first_component = _RE_FIRST_COMPONENT.match(include_base) + if (target_first_component and include_first_component and + target_first_component.group(0) == + include_first_component.group(0)): + return _POSSIBLE_MY_HEADER + + return _OTHER_HEADER + + + +def CheckIncludeLine(filename, clean_lines, linenum, include_state, error): + """Check rules that are applicable to #include lines. + + Strings on #include lines are NOT removed from elided line, to make + certain tasks easier. However, to prevent false positives, checks + applicable to #include lines in CheckLanguage must be put here. + + Args: + filename: The name of the current file. + clean_lines: A CleansedLines instance containing the file. + linenum: The number of the line to check. + include_state: An _IncludeState instance in which the headers are inserted. + error: The function to call with any errors found. + """ + fileinfo = FileInfo(filename) + line = clean_lines.lines[linenum] + + # "include" should use the new style "foo/bar.h" instead of just "bar.h" + # Only do this check if the included header follows google naming + # conventions. If not, assume that it's a 3rd party API that + # requires special include conventions. + # + # We also make an exception for Lua headers, which follow google + # naming convention but not the include convention. + match = Match(r'#include\s*"([^/]+\.h)"', line) + if match and not _THIRD_PARTY_HEADERS_PATTERN.match(match.group(1)): + error(filename, linenum, 'build/include_subdir', 4, + 'Include the directory when naming .h files') + + # we shouldn't include a file more than once. actually, there are a + # handful of instances where doing so is okay, but in general it's + # not. + match = _RE_PATTERN_INCLUDE.search(line) + if match: + include = match.group(2) + is_system = (match.group(1) == '<') + duplicate_line = include_state.FindHeader(include) + if duplicate_line >= 0: + error(filename, linenum, 'build/include', 4, + '"%s" already included at %s:%s' % + (include, filename, duplicate_line)) + return + + for extension in GetNonHeaderExtensions(): + if (include.endswith('.' + extension) and + os.path.dirname(fileinfo.RepositoryName()) != os.path.dirname(include)): + error(filename, linenum, 'build/include', 4, + 'Do not include .' + extension + ' files from other packages') + return + + if not _THIRD_PARTY_HEADERS_PATTERN.match(include): + include_state.include_list[-1].append((include, linenum)) + + # We want to ensure that headers appear in the right order: + # 1) for foo.cc, foo.h (preferred location) + # 2) c system files + # 3) cpp system files + # 4) for foo.cc, foo.h (deprecated location) + # 5) other google headers + # + # We classify each include statement as one of those 5 types + # using a number of techniques. The include_state object keeps + # track of the highest type seen, and complains if we see a + # lower type after that. + error_message = include_state.CheckNextIncludeOrder( + _ClassifyInclude(fileinfo, include, is_system)) + if error_message: + error(filename, linenum, 'build/include_order', 4, + '%s. Should be: %s.h, c system, c++ system, other.' % + (error_message, fileinfo.BaseName())) + canonical_include = include_state.CanonicalizeAlphabeticalOrder(include) + if not include_state.IsInAlphabeticalOrder( + clean_lines, linenum, canonical_include): + error(filename, linenum, 'build/include_alpha', 4, + 'Include "%s" not in alphabetical order' % include) + include_state.SetLastHeader(canonical_include) + + + +def _GetTextInside(text, start_pattern): + r"""Retrieves all the text between matching open and close parentheses. + + Given a string of lines and a regular expression string, retrieve all the text + following the expression and between opening punctuation symbols like + (, [, or {, and the matching close-punctuation symbol. This properly nested + occurrences of the punctuations, so for the text like + printf(a(), b(c())); + a call to _GetTextInside(text, r'printf\(') will return 'a(), b(c())'. + start_pattern must match string having an open punctuation symbol at the end. + + Args: + text: The lines to extract text. Its comments and strings must be elided. + It can be single line and can span multiple lines. + start_pattern: The regexp string indicating where to start extracting + the text. + Returns: + The extracted text. + None if either the opening string or ending punctuation could not be found. + """ + # TODO(unknown): Audit cpplint.py to see what places could be profitably + # rewritten to use _GetTextInside (and use inferior regexp matching today). + + # Give opening punctuations to get the matching close-punctuations. + matching_punctuation = {'(': ')', '{': '}', '[': ']'} + closing_punctuation = set(itervalues(matching_punctuation)) + + # Find the position to start extracting text. + match = re.search(start_pattern, text, re.M) + if not match: # start_pattern not found in text. + return None + start_position = match.end(0) + + assert start_position > 0, ( + 'start_pattern must ends with an opening punctuation.') + assert text[start_position - 1] in matching_punctuation, ( + 'start_pattern must ends with an opening punctuation.') + # Stack of closing punctuations we expect to have in text after position. + punctuation_stack = [matching_punctuation[text[start_position - 1]]] + position = start_position + while punctuation_stack and position < len(text): + if text[position] == punctuation_stack[-1]: + punctuation_stack.pop() + elif text[position] in closing_punctuation: + # A closing punctuation without matching opening punctuations. + return None + elif text[position] in matching_punctuation: + punctuation_stack.append(matching_punctuation[text[position]]) + position += 1 + if punctuation_stack: + # Opening punctuations left without matching close-punctuations. + return None + # punctuations match. + return text[start_position:position - 1] + + +# Patterns for matching call-by-reference parameters. +# +# Supports nested templates up to 2 levels deep using this messy pattern: +# < (?: < (?: < [^<>]* +# > +# | [^<>] )* +# > +# | [^<>] )* +# > +_RE_PATTERN_IDENT = r'[_a-zA-Z]\w*' # =~ [[:alpha:]][[:alnum:]]* +_RE_PATTERN_TYPE = ( + r'(?:const\s+)?(?:typename\s+|class\s+|struct\s+|union\s+|enum\s+)?' + r'(?:\w|' + r'\s*<(?:<(?:<[^<>]*>|[^<>])*>|[^<>])*>|' + r'::)+') +# A call-by-reference parameter ends with '& identifier'. +_RE_PATTERN_REF_PARAM = re.compile( + r'(' + _RE_PATTERN_TYPE + r'(?:\s*(?:\bconst\b|[*]))*\s*' + r'&\s*' + _RE_PATTERN_IDENT + r')\s*(?:=[^,()]+)?[,)]') +# A call-by-const-reference parameter either ends with 'const& identifier' +# or looks like 'const type& identifier' when 'type' is atomic. +_RE_PATTERN_CONST_REF_PARAM = ( + r'(?:.*\s*\bconst\s*&\s*' + _RE_PATTERN_IDENT + + r'|const\s+' + _RE_PATTERN_TYPE + r'\s*&\s*' + _RE_PATTERN_IDENT + r')') +# Stream types. +_RE_PATTERN_REF_STREAM_PARAM = ( + r'(?:.*stream\s*&\s*' + _RE_PATTERN_IDENT + r')') + + +def CheckLanguage(filename, clean_lines, linenum, file_extension, + include_state, nesting_state, error): + """Checks rules from the 'C++ language rules' section of cppguide.html. + + Some of these rules are hard to test (function overloading, using + uint32 inappropriately), but we do the best we can. + + Args: + filename: The name of the current file. + clean_lines: A CleansedLines instance containing the file. + linenum: The number of the line to check. + file_extension: The extension (without the dot) of the filename. + include_state: An _IncludeState instance in which the headers are inserted. + nesting_state: A NestingState instance which maintains information about + the current stack of nested blocks being parsed. + error: The function to call with any errors found. + """ + # If the line is empty or consists of entirely a comment, no need to + # check it. + line = clean_lines.elided[linenum] + if not line: + return + + match = _RE_PATTERN_INCLUDE.search(line) + if match: + CheckIncludeLine(filename, clean_lines, linenum, include_state, error) + return + + # Reset include state across preprocessor directives. This is meant + # to silence warnings for conditional includes. + match = Match(r'^\s*#\s*(if|ifdef|ifndef|elif|else|endif)\b', line) + if match: + include_state.ResetSection(match.group(1)) + + + # Perform other checks now that we are sure that this is not an include line + CheckCasts(filename, clean_lines, linenum, error) + CheckGlobalStatic(filename, clean_lines, linenum, error) + CheckPrintf(filename, clean_lines, linenum, error) + + if file_extension in GetHeaderExtensions(): + # TODO(unknown): check that 1-arg constructors are explicit. + # How to tell it's a constructor? + # (handled in CheckForNonStandardConstructs for now) + # TODO(unknown): check that classes declare or disable copy/assign + # (level 1 error) + pass + + # Check if people are using the verboten C basic types. The only exception + # we regularly allow is "unsigned short port" for port. + if Search(r'\bshort port\b', line): + if not Search(r'\bunsigned short port\b', line): + error(filename, linenum, 'runtime/int', 4, + 'Use "unsigned short" for ports, not "short"') + else: + match = Search(r'\b(short|long(?! +double)|long long)\b', line) + if match: + error(filename, linenum, 'runtime/int', 4, + 'Use int16/int64/etc, rather than the C type %s' % match.group(1)) + + # Check if some verboten operator overloading is going on + # TODO(unknown): catch out-of-line unary operator&: + # class X {}; + # int operator&(const X& x) { return 42; } // unary operator& + # The trick is it's hard to tell apart from binary operator&: + # class Y { int operator&(const Y& x) { return 23; } }; // binary operator& + if Search(r'\boperator\s*&\s*\(\s*\)', line): + error(filename, linenum, 'runtime/operator', 4, + 'Unary operator& is dangerous. Do not use it.') + + # Check for suspicious usage of "if" like + # } if (a == b) { + if Search(r'\}\s*if\s*\(', line): + error(filename, linenum, 'readability/braces', 4, + 'Did you mean "else if"? If not, start a new line for "if".') + + # Check for potential format string bugs like printf(foo). + # We constrain the pattern not to pick things like DocidForPrintf(foo). + # Not perfect but it can catch printf(foo.c_str()) and printf(foo->c_str()) + # TODO(unknown): Catch the following case. Need to change the calling + # convention of the whole function to process multiple line to handle it. + # printf( + # boy_this_is_a_really_long_variable_that_cannot_fit_on_the_prev_line); + printf_args = _GetTextInside(line, r'(?i)\b(string)?printf\s*\(') + if printf_args: + match = Match(r'([\w.\->()]+)$', printf_args) + if match and match.group(1) != '__VA_ARGS__': + function_name = re.search(r'\b((?:string)?printf)\s*\(', + line, re.I).group(1) + error(filename, linenum, 'runtime/printf', 4, + 'Potential format string bug. Do %s("%%s", %s) instead.' + % (function_name, match.group(1))) + + # Check for potential memset bugs like memset(buf, sizeof(buf), 0). + match = Search(r'memset\s*\(([^,]*),\s*([^,]*),\s*0\s*\)', line) + if match and not Match(r"^''|-?[0-9]+|0x[0-9A-Fa-f]$", match.group(2)): + error(filename, linenum, 'runtime/memset', 4, + 'Did you mean "memset(%s, 0, %s)"?' + % (match.group(1), match.group(2))) + + if Search(r'\busing namespace\b', line): + if Search(r'\bliterals\b', line): + error(filename, linenum, 'build/namespaces_literals', 5, + 'Do not use namespace using-directives. ' + 'Use using-declarations instead.') + else: + error(filename, linenum, 'build/namespaces', 5, + 'Do not use namespace using-directives. ' + 'Use using-declarations instead.') + + # Detect variable-length arrays. + match = Match(r'\s*(.+::)?(\w+) [a-z]\w*\[(.+)];', line) + if (match and match.group(2) != 'return' and match.group(2) != 'delete' and + match.group(3).find(']') == -1): + # Split the size using space and arithmetic operators as delimiters. + # If any of the resulting tokens are not compile time constants then + # report the error. + tokens = re.split(r'\s|\+|\-|\*|\/|<<|>>]', match.group(3)) + is_const = True + skip_next = False + for tok in tokens: + if skip_next: + skip_next = False + continue + + if Search(r'sizeof\(.+\)', tok): continue + if Search(r'arraysize\(\w+\)', tok): continue + + tok = tok.lstrip('(') + tok = tok.rstrip(')') + if not tok: continue + if Match(r'\d+', tok): continue + if Match(r'0[xX][0-9a-fA-F]+', tok): continue + if Match(r'k[A-Z0-9]\w*', tok): continue + if Match(r'(.+::)?k[A-Z0-9]\w*', tok): continue + if Match(r'(.+::)?[A-Z][A-Z0-9_]*', tok): continue + # A catch all for tricky sizeof cases, including 'sizeof expression', + # 'sizeof(*type)', 'sizeof(const type)', 'sizeof(struct StructName)' + # requires skipping the next token because we split on ' ' and '*'. + if tok.startswith('sizeof'): + skip_next = True + continue + is_const = False + break + if not is_const: + error(filename, linenum, 'runtime/arrays', 1, + 'Do not use variable-length arrays. Use an appropriately named ' + "('k' followed by CamelCase) compile-time constant for the size.") + + # Check for use of unnamed namespaces in header files. Registration + # macros are typically OK, so we allow use of "namespace {" on lines + # that end with backslashes. + if (file_extension in GetHeaderExtensions() + and Search(r'\bnamespace\s*{', line) + and line[-1] != '\\'): + error(filename, linenum, 'build/namespaces', 4, + 'Do not use unnamed namespaces in header files. See ' + 'https://google-styleguide.googlecode.com/svn/trunk/cppguide.xml#Namespaces' + ' for more information.') + + +def CheckGlobalStatic(filename, clean_lines, linenum, error): + """Check for unsafe global or static objects. + + Args: + filename: The name of the current file. + clean_lines: A CleansedLines instance containing the file. + linenum: The number of the line to check. + error: The function to call with any errors found. + """ + line = clean_lines.elided[linenum] + + # Match two lines at a time to support multiline declarations + if linenum + 1 < clean_lines.NumLines() and not Search(r'[;({]', line): + line += clean_lines.elided[linenum + 1].strip() + + # Check for people declaring static/global STL strings at the top level. + # This is dangerous because the C++ language does not guarantee that + # globals with constructors are initialized before the first access, and + # also because globals can be destroyed when some threads are still running. + # TODO(unknown): Generalize this to also find static unique_ptr instances. + # TODO(unknown): File bugs for clang-tidy to find these. + match = Match( + r'((?:|static +)(?:|const +))(?::*std::)?string( +const)? +' + r'([a-zA-Z0-9_:]+)\b(.*)', + line) + + # Remove false positives: + # - String pointers (as opposed to values). + # string *pointer + # const string *pointer + # string const *pointer + # string *const pointer + # + # - Functions and template specializations. + # string Function(... + # string Class::Method(... + # + # - Operators. These are matched separately because operator names + # cross non-word boundaries, and trying to match both operators + # and functions at the same time would decrease accuracy of + # matching identifiers. + # string Class::operator*() + if (match and + not Search(r'\bstring\b(\s+const)?\s*[\*\&]\s*(const\s+)?\w', line) and + not Search(r'\boperator\W', line) and + not Match(r'\s*(<.*>)?(::[a-zA-Z0-9_]+)*\s*\(([^"]|$)', match.group(4))): + if Search(r'\bconst\b', line): + error(filename, linenum, 'runtime/string', 4, + 'For a static/global string constant, use a C style string ' + 'instead: "%schar%s %s[]".' % + (match.group(1), match.group(2) or '', match.group(3))) + else: + error(filename, linenum, 'runtime/string', 4, + 'Static/global string variables are not permitted.') + + if (Search(r'\b([A-Za-z0-9_]*_)\(\1\)', line) or + Search(r'\b([A-Za-z0-9_]*_)\(CHECK_NOTNULL\(\1\)\)', line)): + error(filename, linenum, 'runtime/init', 4, + 'You seem to be initializing a member variable with itself.') + + +def CheckPrintf(filename, clean_lines, linenum, error): + """Check for printf related issues. + + Args: + filename: The name of the current file. + clean_lines: A CleansedLines instance containing the file. + linenum: The number of the line to check. + error: The function to call with any errors found. + """ + line = clean_lines.elided[linenum] + + # When snprintf is used, the second argument shouldn't be a literal. + match = Search(r'snprintf\s*\(([^,]*),\s*([0-9]*)\s*,', line) + if match and match.group(2) != '0': + # If 2nd arg is zero, snprintf is used to calculate size. + error(filename, linenum, 'runtime/printf', 3, + 'If you can, use sizeof(%s) instead of %s as the 2nd arg ' + 'to snprintf.' % (match.group(1), match.group(2))) + + # Check if some verboten C functions are being used. + if Search(r'\bsprintf\s*\(', line): + error(filename, linenum, 'runtime/printf', 5, + 'Never use sprintf. Use snprintf instead.') + match = Search(r'\b(strcpy|strcat)\s*\(', line) + if match: + error(filename, linenum, 'runtime/printf', 4, + 'Almost always, snprintf is better than %s' % match.group(1)) + + +def IsDerivedFunction(clean_lines, linenum): + """Check if current line contains an inherited function. + + Args: + clean_lines: A CleansedLines instance containing the file. + linenum: The number of the line to check. + Returns: + True if current line contains a function with "override" + virt-specifier. + """ + # Scan back a few lines for start of current function + for i in xrange(linenum, max(-1, linenum - 10), -1): + match = Match(r'^([^()]*\w+)\(', clean_lines.elided[i]) + if match: + # Look for "override" after the matching closing parenthesis + line, _, closing_paren = CloseExpression( + clean_lines, i, len(match.group(1))) + return (closing_paren >= 0 and + Search(r'\boverride\b', line[closing_paren:])) + return False + + +def IsOutOfLineMethodDefinition(clean_lines, linenum): + """Check if current line contains an out-of-line method definition. + + Args: + clean_lines: A CleansedLines instance containing the file. + linenum: The number of the line to check. + Returns: + True if current line contains an out-of-line method definition. + """ + # Scan back a few lines for start of current function + for i in xrange(linenum, max(-1, linenum - 10), -1): + if Match(r'^([^()]*\w+)\(', clean_lines.elided[i]): + return Match(r'^[^()]*\w+::\w+\(', clean_lines.elided[i]) is not None + return False + + +def IsInitializerList(clean_lines, linenum): + """Check if current line is inside constructor initializer list. + + Args: + clean_lines: A CleansedLines instance containing the file. + linenum: The number of the line to check. + Returns: + True if current line appears to be inside constructor initializer + list, False otherwise. + """ + for i in xrange(linenum, 1, -1): + line = clean_lines.elided[i] + if i == linenum: + remove_function_body = Match(r'^(.*)\{\s*$', line) + if remove_function_body: + line = remove_function_body.group(1) + + if Search(r'\s:\s*\w+[({]', line): + # A lone colon tend to indicate the start of a constructor + # initializer list. It could also be a ternary operator, which + # also tend to appear in constructor initializer lists as + # opposed to parameter lists. + return True + if Search(r'\}\s*,\s*$', line): + # A closing brace followed by a comma is probably the end of a + # brace-initialized member in constructor initializer list. + return True + if Search(r'[{};]\s*$', line): + # Found one of the following: + # - A closing brace or semicolon, probably the end of the previous + # function. + # - An opening brace, probably the start of current class or namespace. + # + # Current line is probably not inside an initializer list since + # we saw one of those things without seeing the starting colon. + return False + + # Got to the beginning of the file without seeing the start of + # constructor initializer list. + return False + + +def CheckForNonConstReference(filename, clean_lines, linenum, + nesting_state, error): + """Check for non-const references. + + Separate from CheckLanguage since it scans backwards from current + line, instead of scanning forward. + + Args: + filename: The name of the current file. + clean_lines: A CleansedLines instance containing the file. + linenum: The number of the line to check. + nesting_state: A NestingState instance which maintains information about + the current stack of nested blocks being parsed. + error: The function to call with any errors found. + """ + # Do nothing if there is no '&' on current line. + line = clean_lines.elided[linenum] + if '&' not in line: + return + + # If a function is inherited, current function doesn't have much of + # a choice, so any non-const references should not be blamed on + # derived function. + if IsDerivedFunction(clean_lines, linenum): + return + + # Don't warn on out-of-line method definitions, as we would warn on the + # in-line declaration, if it isn't marked with 'override'. + if IsOutOfLineMethodDefinition(clean_lines, linenum): + return + + # Long type names may be broken across multiple lines, usually in one + # of these forms: + # LongType + # ::LongTypeContinued &identifier + # LongType:: + # LongTypeContinued &identifier + # LongType< + # ...>::LongTypeContinued &identifier + # + # If we detected a type split across two lines, join the previous + # line to current line so that we can match const references + # accordingly. + # + # Note that this only scans back one line, since scanning back + # arbitrary number of lines would be expensive. If you have a type + # that spans more than 2 lines, please use a typedef. + if linenum > 1: + previous = None + if Match(r'\s*::(?:[\w<>]|::)+\s*&\s*\S', line): + # previous_line\n + ::current_line + previous = Search(r'\b((?:const\s*)?(?:[\w<>]|::)+[\w<>])\s*$', + clean_lines.elided[linenum - 1]) + elif Match(r'\s*[a-zA-Z_]([\w<>]|::)+\s*&\s*\S', line): + # previous_line::\n + current_line + previous = Search(r'\b((?:const\s*)?(?:[\w<>]|::)+::)\s*$', + clean_lines.elided[linenum - 1]) + if previous: + line = previous.group(1) + line.lstrip() + else: + # Check for templated parameter that is split across multiple lines + endpos = line.rfind('>') + if endpos > -1: + (_, startline, startpos) = ReverseCloseExpression( + clean_lines, linenum, endpos) + if startpos > -1 and startline < linenum: + # Found the matching < on an earlier line, collect all + # pieces up to current line. + line = '' + for i in xrange(startline, linenum + 1): + line += clean_lines.elided[i].strip() + + # Check for non-const references in function parameters. A single '&' may + # found in the following places: + # inside expression: binary & for bitwise AND + # inside expression: unary & for taking the address of something + # inside declarators: reference parameter + # We will exclude the first two cases by checking that we are not inside a + # function body, including one that was just introduced by a trailing '{'. + # TODO(unknown): Doesn't account for 'catch(Exception& e)' [rare]. + if (nesting_state.previous_stack_top and + not (isinstance(nesting_state.previous_stack_top, _ClassInfo) or + isinstance(nesting_state.previous_stack_top, _NamespaceInfo))): + # Not at toplevel, not within a class, and not within a namespace + return + + # Avoid initializer lists. We only need to scan back from the + # current line for something that starts with ':'. + # + # We don't need to check the current line, since the '&' would + # appear inside the second set of parentheses on the current line as + # opposed to the first set. + if linenum > 0: + for i in xrange(linenum - 1, max(0, linenum - 10), -1): + previous_line = clean_lines.elided[i] + if not Search(r'[),]\s*$', previous_line): + break + if Match(r'^\s*:\s+\S', previous_line): + return + + # Avoid preprocessors + if Search(r'\\\s*$', line): + return + + # Avoid constructor initializer lists + if IsInitializerList(clean_lines, linenum): + return + + # We allow non-const references in a few standard places, like functions + # called "swap()" or iostream operators like "<<" or ">>". Do not check + # those function parameters. + # + # We also accept & in static_assert, which looks like a function but + # it's actually a declaration expression. + whitelisted_functions = (r'(?:[sS]wap(?:<\w:+>)?|' + r'operator\s*[<>][<>]|' + r'static_assert|COMPILE_ASSERT' + r')\s*\(') + if Search(whitelisted_functions, line): + return + elif not Search(r'\S+\([^)]*$', line): + # Don't see a whitelisted function on this line. Actually we + # didn't see any function name on this line, so this is likely a + # multi-line parameter list. Try a bit harder to catch this case. + for i in xrange(2): + if (linenum > i and + Search(whitelisted_functions, clean_lines.elided[linenum - i - 1])): + return + + decls = ReplaceAll(r'{[^}]*}', ' ', line) # exclude function body + for parameter in re.findall(_RE_PATTERN_REF_PARAM, decls): + if (not Match(_RE_PATTERN_CONST_REF_PARAM, parameter) and + not Match(_RE_PATTERN_REF_STREAM_PARAM, parameter)): + error(filename, linenum, 'runtime/references', 2, + 'Is this a non-const reference? ' + 'If so, make const or use a pointer: ' + + ReplaceAll(' *<', '<', parameter)) + + +def CheckCasts(filename, clean_lines, linenum, error): + """Various cast related checks. + + Args: + filename: The name of the current file. + clean_lines: A CleansedLines instance containing the file. + linenum: The number of the line to check. + error: The function to call with any errors found. + """ + line = clean_lines.elided[linenum] + + # Check to see if they're using an conversion function cast. + # I just try to capture the most common basic types, though there are more. + # Parameterless conversion functions, such as bool(), are allowed as they are + # probably a member operator declaration or default constructor. + match = Search( + r'(\bnew\s+(?:const\s+)?|\S<\s*(?:const\s+)?)?\b' + r'(int|float|double|bool|char|int32|uint32|int64|uint64)' + r'(\([^)].*)', line) + expecting_function = ExpectingFunctionArgs(clean_lines, linenum) + if match and not expecting_function: + matched_type = match.group(2) + + # matched_new_or_template is used to silence two false positives: + # - New operators + # - Template arguments with function types + # + # For template arguments, we match on types immediately following + # an opening bracket without any spaces. This is a fast way to + # silence the common case where the function type is the first + # template argument. False negative with less-than comparison is + # avoided because those operators are usually followed by a space. + # + # function // bracket + no space = false positive + # value < double(42) // bracket + space = true positive + matched_new_or_template = match.group(1) + + # Avoid arrays by looking for brackets that come after the closing + # parenthesis. + if Match(r'\([^()]+\)\s*\[', match.group(3)): + return + + # Other things to ignore: + # - Function pointers + # - Casts to pointer types + # - Placement new + # - Alias declarations + matched_funcptr = match.group(3) + if (matched_new_or_template is None and + not (matched_funcptr and + (Match(r'\((?:[^() ]+::\s*\*\s*)?[^() ]+\)\s*\(', + matched_funcptr) or + matched_funcptr.startswith('(*)'))) and + not Match(r'\s*using\s+\S+\s*=\s*' + matched_type, line) and + not Search(r'new\(\S+\)\s*' + matched_type, line)): + error(filename, linenum, 'readability/casting', 4, + 'Using deprecated casting style. ' + 'Use static_cast<%s>(...) instead' % + matched_type) + + if not expecting_function: + CheckCStyleCast(filename, clean_lines, linenum, 'static_cast', + r'\((int|float|double|bool|char|u?int(16|32|64))\)', error) + + # This doesn't catch all cases. Consider (const char * const)"hello". + # + # (char *) "foo" should always be a const_cast (reinterpret_cast won't + # compile). + if CheckCStyleCast(filename, clean_lines, linenum, 'const_cast', + r'\((char\s?\*+\s?)\)\s*"', error): + pass + else: + # Check pointer casts for other than string constants + CheckCStyleCast(filename, clean_lines, linenum, 'reinterpret_cast', + r'\((\w+\s?\*+\s?)\)', error) + + # In addition, we look for people taking the address of a cast. This + # is dangerous -- casts can assign to temporaries, so the pointer doesn't + # point where you think. + # + # Some non-identifier character is required before the '&' for the + # expression to be recognized as a cast. These are casts: + # expression = &static_cast(temporary()); + # function(&(int*)(temporary())); + # + # This is not a cast: + # reference_type&(int* function_param); + match = Search( + r'(?:[^\w]&\(([^)*][^)]*)\)[\w(])|' + r'(?:[^\w]&(static|dynamic|down|reinterpret)_cast\b)', line) + if match: + # Try a better error message when the & is bound to something + # dereferenced by the casted pointer, as opposed to the casted + # pointer itself. + parenthesis_error = False + match = Match(r'^(.*&(?:static|dynamic|down|reinterpret)_cast\b)<', line) + if match: + _, y1, x1 = CloseExpression(clean_lines, linenum, len(match.group(1))) + if x1 >= 0 and clean_lines.elided[y1][x1] == '(': + _, y2, x2 = CloseExpression(clean_lines, y1, x1) + if x2 >= 0: + extended_line = clean_lines.elided[y2][x2:] + if y2 < clean_lines.NumLines() - 1: + extended_line += clean_lines.elided[y2 + 1] + if Match(r'\s*(?:->|\[)', extended_line): + parenthesis_error = True + + if parenthesis_error: + error(filename, linenum, 'readability/casting', 4, + ('Are you taking an address of something dereferenced ' + 'from a cast? Wrapping the dereferenced expression in ' + 'parentheses will make the binding more obvious')) + else: + error(filename, linenum, 'runtime/casting', 4, + ('Are you taking an address of a cast? ' + 'This is dangerous: could be a temp var. ' + 'Take the address before doing the cast, rather than after')) + + +def CheckCStyleCast(filename, clean_lines, linenum, cast_type, pattern, error): + """Checks for a C-style cast by looking for the pattern. + + Args: + filename: The name of the current file. + clean_lines: A CleansedLines instance containing the file. + linenum: The number of the line to check. + cast_type: The string for the C++ cast to recommend. This is either + reinterpret_cast, static_cast, or const_cast, depending. + pattern: The regular expression used to find C-style casts. + error: The function to call with any errors found. + + Returns: + True if an error was emitted. + False otherwise. + """ + line = clean_lines.elided[linenum] + match = Search(pattern, line) + if not match: + return False + + # Exclude lines with keywords that tend to look like casts + context = line[0:match.start(1) - 1] + if Match(r'.*\b(?:sizeof|alignof|alignas|[_A-Z][_A-Z0-9]*)\s*$', context): + return False + + # Try expanding current context to see if we one level of + # parentheses inside a macro. + if linenum > 0: + for i in xrange(linenum - 1, max(0, linenum - 5), -1): + context = clean_lines.elided[i] + context + if Match(r'.*\b[_A-Z][_A-Z0-9]*\s*\((?:\([^()]*\)|[^()])*$', context): + return False + + # operator++(int) and operator--(int) + if context.endswith(' operator++') or context.endswith(' operator--'): + return False + + # A single unnamed argument for a function tends to look like old style cast. + # If we see those, don't issue warnings for deprecated casts. + remainder = line[match.end(0):] + if Match(r'^\s*(?:;|const\b|throw\b|final\b|override\b|[=>{),]|->)', + remainder): + return False + + # At this point, all that should be left is actual casts. + error(filename, linenum, 'readability/casting', 4, + 'Using C-style cast. Use %s<%s>(...) instead' % + (cast_type, match.group(1))) + + return True + + +def ExpectingFunctionArgs(clean_lines, linenum): + """Checks whether where function type arguments are expected. + + Args: + clean_lines: A CleansedLines instance containing the file. + linenum: The number of the line to check. + + Returns: + True if the line at 'linenum' is inside something that expects arguments + of function types. + """ + line = clean_lines.elided[linenum] + return (Match(r'^\s*MOCK_(CONST_)?METHOD\d+(_T)?\(', line) or + (linenum >= 2 and + (Match(r'^\s*MOCK_(?:CONST_)?METHOD\d+(?:_T)?\((?:\S+,)?\s*$', + clean_lines.elided[linenum - 1]) or + Match(r'^\s*MOCK_(?:CONST_)?METHOD\d+(?:_T)?\(\s*$', + clean_lines.elided[linenum - 2]) or + Search(r'\bstd::m?function\s*\<\s*$', + clean_lines.elided[linenum - 1])))) + + +_HEADERS_CONTAINING_TEMPLATES = ( + ('', ('deque',)), + ('', ('unary_function', 'binary_function', + 'plus', 'minus', 'multiplies', 'divides', 'modulus', + 'negate', + 'equal_to', 'not_equal_to', 'greater', 'less', + 'greater_equal', 'less_equal', + 'logical_and', 'logical_or', 'logical_not', + 'unary_negate', 'not1', 'binary_negate', 'not2', + 'bind1st', 'bind2nd', + 'pointer_to_unary_function', + 'pointer_to_binary_function', + 'ptr_fun', + 'mem_fun_t', 'mem_fun', 'mem_fun1_t', 'mem_fun1_ref_t', + 'mem_fun_ref_t', + 'const_mem_fun_t', 'const_mem_fun1_t', + 'const_mem_fun_ref_t', 'const_mem_fun1_ref_t', + 'mem_fun_ref', + )), + ('', ('numeric_limits',)), + ('', ('list',)), + ('', ('map', 'multimap',)), + ('', ('allocator',)), + ('', ('queue', 'priority_queue',)), + ('', ('set', 'multiset',)), + ('', ('stack',)), + ('', ('char_traits', 'basic_string',)), + ('', ('tuple',)), + ('', ('pair',)), + ('', ('vector',)), + + # gcc extensions. + # Note: std::hash is their hash, ::hash is our hash + ('', ('hash_map', 'hash_multimap',)), + ('', ('hash_set', 'hash_multiset',)), + ('', ('slist',)), + ) + +_HEADERS_MAYBE_TEMPLATES = ( + ('', ('copy', 'max', 'min', 'min_element', 'sort', + 'transform', + )), + ('', ('swap',)), + ) + +_RE_PATTERN_STRING = re.compile(r'\bstring\b') + +_re_pattern_headers_maybe_templates = [] +for _header, _templates in _HEADERS_MAYBE_TEMPLATES: + for _template in _templates: + # Match max(..., ...), max(..., ...), but not foo->max, foo.max or + # type::max(). + _re_pattern_headers_maybe_templates.append( + (re.compile(r'[^>.]\b' + _template + r'(<.*?>)?\([^\)]'), + _template, + _header)) + +# Other scripts may reach in and modify this pattern. +_re_pattern_templates = [] +for _header, _templates in _HEADERS_CONTAINING_TEMPLATES: + for _template in _templates: + _re_pattern_templates.append( + (re.compile(r'(\<|\b)' + _template + r'\s*\<'), + _template + '<>', + _header)) + + +def FilesBelongToSameModule(filename_cc, filename_h): + """Check if these two filenames belong to the same module. + + The concept of a 'module' here is a as follows: + foo.h, foo-inl.h, foo.cc, foo_test.cc and foo_unittest.cc belong to the + same 'module' if they are in the same directory. + some/path/public/xyzzy and some/path/internal/xyzzy are also considered + to belong to the same module here. + + If the filename_cc contains a longer path than the filename_h, for example, + '/absolute/path/to/base/sysinfo.cc', and this file would include + 'base/sysinfo.h', this function also produces the prefix needed to open the + header. This is used by the caller of this function to more robustly open the + header file. We don't have access to the real include paths in this context, + so we need this guesswork here. + + Known bugs: tools/base/bar.cc and base/bar.h belong to the same module + according to this implementation. Because of this, this function gives + some false positives. This should be sufficiently rare in practice. + + Args: + filename_cc: is the path for the source (e.g. .cc) file + filename_h: is the path for the header path + + Returns: + Tuple with a bool and a string: + bool: True if filename_cc and filename_h belong to the same module. + string: the additional prefix needed to open the header file. + """ + fileinfo_cc = FileInfo(filename_cc) + if not fileinfo_cc.Extension().lstrip('.') in GetNonHeaderExtensions(): + return (False, '') + + fileinfo_h = FileInfo(filename_h) + if not fileinfo_h.Extension().lstrip('.') in GetHeaderExtensions(): + return (False, '') + + filename_cc = filename_cc[:-(len(fileinfo_cc.Extension()))] + matched_test_suffix = Search(_TEST_FILE_SUFFIX, fileinfo_cc.BaseName()) + if matched_test_suffix: + filename_cc = filename_cc[:-len(matched_test_suffix.group(1))] + + filename_cc = filename_cc.replace('/public/', '/') + filename_cc = filename_cc.replace('/internal/', '/') + + filename_h = filename_h[:-(len(fileinfo_h.Extension()))] + if filename_h.endswith('-inl'): + filename_h = filename_h[:-len('-inl')] + filename_h = filename_h.replace('/public/', '/') + filename_h = filename_h.replace('/internal/', '/') + + files_belong_to_same_module = filename_cc.endswith(filename_h) + common_path = '' + if files_belong_to_same_module: + common_path = filename_cc[:-len(filename_h)] + return files_belong_to_same_module, common_path + + +def UpdateIncludeState(filename, include_dict, io=codecs): + """Fill up the include_dict with new includes found from the file. + + Args: + filename: the name of the header to read. + include_dict: a dictionary in which the headers are inserted. + io: The io factory to use to read the file. Provided for testability. + + Returns: + True if a header was successfully added. False otherwise. + """ + headerfile = None + try: + headerfile = io.open(filename, 'r', 'utf8', 'replace') + except IOError: + return False + linenum = 0 + for line in headerfile: + linenum += 1 + clean_line = CleanseComments(line) + match = _RE_PATTERN_INCLUDE.search(clean_line) + if match: + include = match.group(2) + include_dict.setdefault(include, linenum) + return True + + +def CheckForIncludeWhatYouUse(filename, clean_lines, include_state, error, + io=codecs): + """Reports for missing stl includes. + + This function will output warnings to make sure you are including the headers + necessary for the stl containers and functions that you use. We only give one + reason to include a header. For example, if you use both equal_to<> and + less<> in a .h file, only one (the latter in the file) of these will be + reported as a reason to include the . + + Args: + filename: The name of the current file. + clean_lines: A CleansedLines instance containing the file. + include_state: An _IncludeState instance. + error: The function to call with any errors found. + io: The IO factory to use to read the header file. Provided for unittest + injection. + """ + required = {} # A map of header name to linenumber and the template entity. + # Example of required: { '': (1219, 'less<>') } + + for linenum in range(clean_lines.NumLines()): + line = clean_lines.elided[linenum] + if not line or line[0] == '#': + continue + + # String is special -- it is a non-templatized type in STL. + matched = _RE_PATTERN_STRING.search(line) + if matched: + # Don't warn about strings in non-STL namespaces: + # (We check only the first match per line; good enough.) + prefix = line[:matched.start()] + if prefix.endswith('std::') or not prefix.endswith('::'): + required[''] = (linenum, 'string') + + for pattern, template, header in _re_pattern_headers_maybe_templates: + if pattern.search(line): + required[header] = (linenum, template) + + # The following function is just a speed up, no semantics are changed. + if not '<' in line: # Reduces the cpu time usage by skipping lines. + continue + + for pattern, template, header in _re_pattern_templates: + if pattern.search(line): + required[header] = (linenum, template) + + # The policy is that if you #include something in foo.h you don't need to + # include it again in foo.cc. Here, we will look at possible includes. + # Let's flatten the include_state include_list and copy it into a dictionary. + include_dict = dict([item for sublist in include_state.include_list + for item in sublist]) + + # Did we find the header for this file (if any) and successfully load it? + header_found = False + + # Use the absolute path so that matching works properly. + abs_filename = FileInfo(filename).FullName() + + # For Emacs's flymake. + # If cpplint is invoked from Emacs's flymake, a temporary file is generated + # by flymake and that file name might end with '_flymake.cc'. In that case, + # restore original file name here so that the corresponding header file can be + # found. + # e.g. If the file name is 'foo_flymake.cc', we should search for 'foo.h' + # instead of 'foo_flymake.h' + abs_filename = re.sub(r'_flymake\.cc$', '.cc', abs_filename) + + # include_dict is modified during iteration, so we iterate over a copy of + # the keys. + header_keys = list(include_dict.keys()) + for header in header_keys: + (same_module, common_path) = FilesBelongToSameModule(abs_filename, header) + fullpath = common_path + header + if same_module and UpdateIncludeState(fullpath, include_dict, io): + header_found = True + + # If we can't find the header file for a .cc, assume it's because we don't + # know where to look. In that case we'll give up as we're not sure they + # didn't include it in the .h file. + # TODO(unknown): Do a better job of finding .h files so we are confident that + # not having the .h file means there isn't one. + if not header_found: + for extension in GetNonHeaderExtensions(): + if filename.endswith('.' + extension): + return + + # All the lines have been processed, report the errors found. + for required_header_unstripped in sorted(required, key=required.__getitem__): + template = required[required_header_unstripped][1] + if required_header_unstripped.strip('<>"') not in include_dict: + error(filename, required[required_header_unstripped][0], + 'build/include_what_you_use', 4, + 'Add #include ' + required_header_unstripped + ' for ' + template) + + +_RE_PATTERN_EXPLICIT_MAKEPAIR = re.compile(r'\bmake_pair\s*<') + + +def CheckMakePairUsesDeduction(filename, clean_lines, linenum, error): + """Check that make_pair's template arguments are deduced. + + G++ 4.6 in C++11 mode fails badly if make_pair's template arguments are + specified explicitly, and such use isn't intended in any case. + + Args: + filename: The name of the current file. + clean_lines: A CleansedLines instance containing the file. + linenum: The number of the line to check. + error: The function to call with any errors found. + """ + line = clean_lines.elided[linenum] + match = _RE_PATTERN_EXPLICIT_MAKEPAIR.search(line) + if match: + error(filename, linenum, 'build/explicit_make_pair', + 4, # 4 = high confidence + 'For C++11-compatibility, omit template arguments from make_pair' + ' OR use pair directly OR if appropriate, construct a pair directly') + + +def CheckRedundantVirtual(filename, clean_lines, linenum, error): + """Check if line contains a redundant "virtual" function-specifier. + + Args: + filename: The name of the current file. + clean_lines: A CleansedLines instance containing the file. + linenum: The number of the line to check. + error: The function to call with any errors found. + """ + # Look for "virtual" on current line. + line = clean_lines.elided[linenum] + virtual = Match(r'^(.*)(\bvirtual\b)(.*)$', line) + if not virtual: return + + # Ignore "virtual" keywords that are near access-specifiers. These + # are only used in class base-specifier and do not apply to member + # functions. + if (Search(r'\b(public|protected|private)\s+$', virtual.group(1)) or + Match(r'^\s+(public|protected|private)\b', virtual.group(3))): + return + + # Ignore the "virtual" keyword from virtual base classes. Usually + # there is a column on the same line in these cases (virtual base + # classes are rare in google3 because multiple inheritance is rare). + if Match(r'^.*[^:]:[^:].*$', line): return + + # Look for the next opening parenthesis. This is the start of the + # parameter list (possibly on the next line shortly after virtual). + # TODO(unknown): doesn't work if there are virtual functions with + # decltype() or other things that use parentheses, but csearch suggests + # that this is rare. + end_col = -1 + end_line = -1 + start_col = len(virtual.group(2)) + for start_line in xrange(linenum, min(linenum + 3, clean_lines.NumLines())): + line = clean_lines.elided[start_line][start_col:] + parameter_list = Match(r'^([^(]*)\(', line) + if parameter_list: + # Match parentheses to find the end of the parameter list + (_, end_line, end_col) = CloseExpression( + clean_lines, start_line, start_col + len(parameter_list.group(1))) + break + start_col = 0 + + if end_col < 0: + return # Couldn't find end of parameter list, give up + + # Look for "override" or "final" after the parameter list + # (possibly on the next few lines). + for i in xrange(end_line, min(end_line + 3, clean_lines.NumLines())): + line = clean_lines.elided[i][end_col:] + match = Search(r'\b(override|final)\b', line) + if match: + error(filename, linenum, 'readability/inheritance', 4, + ('"virtual" is redundant since function is ' + 'already declared as "%s"' % match.group(1))) + + # Set end_col to check whole lines after we are done with the + # first line. + end_col = 0 + if Search(r'[^\w]\s*$', line): + break + + +def CheckRedundantOverrideOrFinal(filename, clean_lines, linenum, error): + """Check if line contains a redundant "override" or "final" virt-specifier. + + Args: + filename: The name of the current file. + clean_lines: A CleansedLines instance containing the file. + linenum: The number of the line to check. + error: The function to call with any errors found. + """ + # Look for closing parenthesis nearby. We need one to confirm where + # the declarator ends and where the virt-specifier starts to avoid + # false positives. + line = clean_lines.elided[linenum] + declarator_end = line.rfind(')') + if declarator_end >= 0: + fragment = line[declarator_end:] + else: + if linenum > 1 and clean_lines.elided[linenum - 1].rfind(')') >= 0: + fragment = line + else: + return + + # Check that at most one of "override" or "final" is present, not both + if Search(r'\boverride\b', fragment) and Search(r'\bfinal\b', fragment): + error(filename, linenum, 'readability/inheritance', 4, + ('"override" is redundant since function is ' + 'already declared as "final"')) + + + + +# Returns true if we are at a new block, and it is directly +# inside of a namespace. +def IsBlockInNameSpace(nesting_state, is_forward_declaration): + """Checks that the new block is directly in a namespace. + + Args: + nesting_state: The _NestingState object that contains info about our state. + is_forward_declaration: If the class is a forward declared class. + Returns: + Whether or not the new block is directly in a namespace. + """ + if is_forward_declaration: + return len(nesting_state.stack) >= 1 and ( + isinstance(nesting_state.stack[-1], _NamespaceInfo)) + + + return (len(nesting_state.stack) > 1 and + nesting_state.stack[-1].check_namespace_indentation and + isinstance(nesting_state.stack[-2], _NamespaceInfo)) + + +def ShouldCheckNamespaceIndentation(nesting_state, is_namespace_indent_item, + raw_lines_no_comments, linenum): + """This method determines if we should apply our namespace indentation check. + + Args: + nesting_state: The current nesting state. + is_namespace_indent_item: If we just put a new class on the stack, True. + If the top of the stack is not a class, or we did not recently + add the class, False. + raw_lines_no_comments: The lines without the comments. + linenum: The current line number we are processing. + + Returns: + True if we should apply our namespace indentation check. Currently, it + only works for classes and namespaces inside of a namespace. + """ + + is_forward_declaration = IsForwardClassDeclaration(raw_lines_no_comments, + linenum) + + if not (is_namespace_indent_item or is_forward_declaration): + return False + + # If we are in a macro, we do not want to check the namespace indentation. + if IsMacroDefinition(raw_lines_no_comments, linenum): + return False + + return IsBlockInNameSpace(nesting_state, is_forward_declaration) + + +# Call this method if the line is directly inside of a namespace. +# If the line above is blank (excluding comments) or the start of +# an inner namespace, it cannot be indented. +def CheckItemIndentationInNamespace(filename, raw_lines_no_comments, linenum, + error): + line = raw_lines_no_comments[linenum] + if Match(r'^\s+', line): + error(filename, linenum, 'runtime/indentation_namespace', 4, + 'Do not indent within a namespace') + + +def ProcessLine(filename, file_extension, clean_lines, line, + include_state, function_state, nesting_state, error, + extra_check_functions=None): + """Processes a single line in the file. + + Args: + filename: Filename of the file that is being processed. + file_extension: The extension (dot not included) of the file. + clean_lines: An array of strings, each representing a line of the file, + with comments stripped. + line: Number of line being processed. + include_state: An _IncludeState instance in which the headers are inserted. + function_state: A _FunctionState instance which counts function lines, etc. + nesting_state: A NestingState instance which maintains information about + the current stack of nested blocks being parsed. + error: A callable to which errors are reported, which takes 4 arguments: + filename, line number, error level, and message + extra_check_functions: An array of additional check functions that will be + run on each source line. Each function takes 4 + arguments: filename, clean_lines, line, error + """ + raw_lines = clean_lines.raw_lines + ParseNolintSuppressions(filename, raw_lines[line], line, error) + nesting_state.Update(filename, clean_lines, line, error) + CheckForNamespaceIndentation(filename, nesting_state, clean_lines, line, + error) + if nesting_state.InAsmBlock(): return + CheckForFunctionLengths(filename, clean_lines, line, function_state, error) + CheckForMultilineCommentsAndStrings(filename, clean_lines, line, error) + CheckStyle(filename, clean_lines, line, file_extension, nesting_state, error) + CheckLanguage(filename, clean_lines, line, file_extension, include_state, + nesting_state, error) + CheckForNonConstReference(filename, clean_lines, line, nesting_state, error) + CheckForNonStandardConstructs(filename, clean_lines, line, + nesting_state, error) + CheckVlogArguments(filename, clean_lines, line, error) + CheckPosixThreading(filename, clean_lines, line, error) + CheckInvalidIncrement(filename, clean_lines, line, error) + CheckMakePairUsesDeduction(filename, clean_lines, line, error) + CheckRedundantVirtual(filename, clean_lines, line, error) + CheckRedundantOverrideOrFinal(filename, clean_lines, line, error) + if extra_check_functions: + for check_fn in extra_check_functions: + check_fn(filename, clean_lines, line, error) + +def FlagCxx11Features(filename, clean_lines, linenum, error): + """Flag those c++11 features that we only allow in certain places. + + Args: + filename: The name of the current file. + clean_lines: A CleansedLines instance containing the file. + linenum: The number of the line to check. + error: The function to call with any errors found. + """ + line = clean_lines.elided[linenum] + + include = Match(r'\s*#\s*include\s+[<"]([^<"]+)[">]', line) + + # Flag unapproved C++ TR1 headers. + if include and include.group(1).startswith('tr1/'): + error(filename, linenum, 'build/c++tr1', 5, + ('C++ TR1 headers such as <%s> are unapproved.') % include.group(1)) + + # Flag unapproved C++11 headers. + if include and include.group(1) in ('cfenv', + 'condition_variable', + 'fenv.h', + 'future', + 'mutex', + 'thread', + 'chrono', + 'ratio', + 'regex', + 'system_error', + ): + error(filename, linenum, 'build/c++11', 5, + ('<%s> is an unapproved C++11 header.') % include.group(1)) + + # The only place where we need to worry about C++11 keywords and library + # features in preprocessor directives is in macro definitions. + if Match(r'\s*#', line) and not Match(r'\s*#\s*define\b', line): return + + # These are classes and free functions. The classes are always + # mentioned as std::*, but we only catch the free functions if + # they're not found by ADL. They're alphabetical by header. + for top_name in ( + # type_traits + 'alignment_of', + 'aligned_union', + ): + if Search(r'\bstd::%s\b' % top_name, line): + error(filename, linenum, 'build/c++11', 5, + ('std::%s is an unapproved C++11 class or function. Send c-style ' + 'an example of where it would make your code more readable, and ' + 'they may let you use it.') % top_name) + + +def FlagCxx14Features(filename, clean_lines, linenum, error): + """Flag those C++14 features that we restrict. + + Args: + filename: The name of the current file. + clean_lines: A CleansedLines instance containing the file. + linenum: The number of the line to check. + error: The function to call with any errors found. + """ + line = clean_lines.elided[linenum] + + include = Match(r'\s*#\s*include\s+[<"]([^<"]+)[">]', line) + + # Flag unapproved C++14 headers. + if include and include.group(1) in ('scoped_allocator', 'shared_mutex'): + error(filename, linenum, 'build/c++14', 5, + ('<%s> is an unapproved C++14 header.') % include.group(1)) + + +def ProcessFileData(filename, file_extension, lines, error, + extra_check_functions=None): + """Performs lint checks and reports any errors to the given error function. + + Args: + filename: Filename of the file that is being processed. + file_extension: The extension (dot not included) of the file. + lines: An array of strings, each representing a line of the file, with the + last element being empty if the file is terminated with a newline. + error: A callable to which errors are reported, which takes 4 arguments: + filename, line number, error level, and message + extra_check_functions: An array of additional check functions that will be + run on each source line. Each function takes 4 + arguments: filename, clean_lines, line, error + """ + lines = (['// marker so line numbers and indices both start at 1'] + lines + + ['// marker so line numbers end in a known way']) + + include_state = _IncludeState() + function_state = _FunctionState() + nesting_state = NestingState() + + ResetNolintSuppressions() + + CheckForCopyright(filename, lines, error) + ProcessGlobalSuppresions(lines) + RemoveMultiLineComments(filename, lines, error) + clean_lines = CleansedLines(lines) + + if file_extension in GetHeaderExtensions(): + CheckForHeaderGuard(filename, clean_lines, error) + + for line in range(clean_lines.NumLines()): + ProcessLine(filename, file_extension, clean_lines, line, + include_state, function_state, nesting_state, error, + extra_check_functions) + FlagCxx11Features(filename, clean_lines, line, error) + nesting_state.CheckCompletedBlocks(filename, error) + + CheckForIncludeWhatYouUse(filename, clean_lines, include_state, error) + + # Check that the .cc file has included its header if it exists. + if _IsSourceExtension(file_extension): + CheckHeaderFileIncluded(filename, include_state, error) + + # We check here rather than inside ProcessLine so that we see raw + # lines rather than "cleaned" lines. + CheckForBadCharacters(filename, lines, error) + + CheckForNewlineAtEOF(filename, lines, error) + +def ProcessConfigOverrides(filename): + """ Loads the configuration files and processes the config overrides. + + Args: + filename: The name of the file being processed by the linter. + + Returns: + False if the current |filename| should not be processed further. + """ + + abs_filename = os.path.abspath(filename) + cfg_filters = [] + keep_looking = True + while keep_looking: + abs_path, base_name = os.path.split(abs_filename) + if not base_name: + break # Reached the root directory. + + cfg_file = os.path.join(abs_path, "CPPLINT.cfg") + abs_filename = abs_path + if not os.path.isfile(cfg_file): + continue + + try: + with open(cfg_file) as file_handle: + for line in file_handle: + line, _, _ = line.partition('#') # Remove comments. + if not line.strip(): + continue + + name, _, val = line.partition('=') + name = name.strip() + val = val.strip() + if name == 'set noparent': + keep_looking = False + elif name == 'filter': + cfg_filters.append(val) + elif name == 'exclude_files': + # When matching exclude_files pattern, use the base_name of + # the current file name or the directory name we are processing. + # For example, if we are checking for lint errors in /foo/bar/baz.cc + # and we found the .cfg file at /foo/CPPLINT.cfg, then the config + # file's "exclude_files" filter is meant to be checked against "bar" + # and not "baz" nor "bar/baz.cc". + if base_name: + pattern = re.compile(val) + if pattern.match(base_name): + _cpplint_state.PrintInfo('Ignoring "%s": file excluded by ' + '"%s". File path component "%s" matches pattern "%s"\n' % + (filename, cfg_file, base_name, val)) + return False + elif name == 'linelength': + global _line_length + try: + _line_length = int(val) + except ValueError: + _cpplint_state.PrintError('Line length must be numeric.') + elif name == 'extensions': + global _valid_extensions + try: + extensions = [ext.strip() for ext in val.split(',')] + _valid_extensions = set(extensions) + except ValueError: + sys.stderr.write('Extensions should be a comma-separated list of values;' + 'for example: extensions=hpp,cpp\n' + 'This could not be parsed: "%s"' % (val,)) + elif name == 'headers': + global _header_extensions + try: + extensions = [ext.strip() for ext in val.split(',')] + _header_extensions = set(extensions) + except ValueError: + sys.stderr.write('Extensions should be a comma-separated list of values;' + 'for example: extensions=hpp,cpp\n' + 'This could not be parsed: "%s"' % (val,)) + elif name == 'root': + global _root + _root = val + else: + _cpplint_state.PrintError( + 'Invalid configuration option (%s) in file %s\n' % + (name, cfg_file)) + + except IOError: + _cpplint_state.PrintError( + "Skipping config file '%s': Can't open for reading\n" % cfg_file) + keep_looking = False + + # Apply all the accumulated filters in reverse order (top-level directory + # config options having the least priority). + for cfg_filter in reversed(cfg_filters): + _AddFilters(cfg_filter) + + return True + + +def ProcessFile(filename, vlevel, extra_check_functions=None): + """Does google-lint on a single file. + + Args: + filename: The name of the file to parse. + + vlevel: The level of errors to report. Every error of confidence + >= verbose_level will be reported. 0 is a good default. + + extra_check_functions: An array of additional check functions that will be + run on each source line. Each function takes 4 + arguments: filename, clean_lines, line, error + """ + + _SetVerboseLevel(vlevel) + _BackupFilters() + + if not ProcessConfigOverrides(filename): + _RestoreFilters() + return + + lf_lines = [] + crlf_lines = [] + try: + # Support the UNIX convention of using "-" for stdin. Note that + # we are not opening the file with universal newline support + # (which codecs doesn't support anyway), so the resulting lines do + # contain trailing '\r' characters if we are reading a file that + # has CRLF endings. + # If after the split a trailing '\r' is present, it is removed + # below. + if filename == '-': + lines = codecs.StreamReaderWriter(sys.stdin, + codecs.getreader('utf8'), + codecs.getwriter('utf8'), + 'replace').read().split('\n') + else: + lines = codecs.open(filename, 'r', 'utf8', 'replace').read().split('\n') + + # Remove trailing '\r'. + # The -1 accounts for the extra trailing blank line we get from split() + for linenum in range(len(lines) - 1): + if lines[linenum].endswith('\r'): + lines[linenum] = lines[linenum].rstrip('\r') + crlf_lines.append(linenum + 1) + else: + lf_lines.append(linenum + 1) + + except IOError: + _cpplint_state.PrintError( + "Skipping input '%s': Can't open for reading\n" % filename) + _RestoreFilters() + return + + # Note, if no dot is found, this will give the entire filename as the ext. + file_extension = filename[filename.rfind('.') + 1:] + + # When reading from stdin, the extension is unknown, so no cpplint tests + # should rely on the extension. + if filename != '-' and file_extension not in GetAllExtensions(): + _cpplint_state.PrintError('Ignoring %s; not a valid file name ' + '(%s)\n' % (filename, ', '.join(GetAllExtensions()))) + else: + ProcessFileData(filename, file_extension, lines, Error, + extra_check_functions) + + # If end-of-line sequences are a mix of LF and CR-LF, issue + # warnings on the lines with CR. + # + # Don't issue any warnings if all lines are uniformly LF or CR-LF, + # since critique can handle these just fine, and the style guide + # doesn't dictate a particular end of line sequence. + # + # We can't depend on os.linesep to determine what the desired + # end-of-line sequence should be, since that will return the + # server-side end-of-line sequence. + if lf_lines and crlf_lines: + # Warn on every line with CR. An alternative approach might be to + # check whether the file is mostly CRLF or just LF, and warn on the + # minority, we bias toward LF here since most tools prefer LF. + for linenum in crlf_lines: + Error(filename, linenum, 'whitespace/newline', 1, + 'Unexpected \\r (^M) found; better to use only \\n') + + _cpplint_state.PrintInfo('Done processing %s\n' % filename) + _RestoreFilters() + + +def PrintUsage(message): + """Prints a brief usage string and exits, optionally with an error message. + + Args: + message: The optional error message. + """ + sys.stderr.write(_USAGE) + + if message: + sys.exit('\nFATAL ERROR: ' + message) + else: + sys.exit(0) + + +def PrintCategories(): + """Prints a list of all the error-categories used by error messages. + + These are the categories used to filter messages via --filter. + """ + sys.stderr.write(''.join(' %s\n' % cat for cat in _ERROR_CATEGORIES)) + sys.exit(0) + + +def ParseArguments(args): + """Parses the command line arguments. + + This may set the output format and verbosity level as side-effects. + + Args: + args: The command line arguments: + + Returns: + The list of filenames to lint. + """ + try: + (opts, filenames) = getopt.getopt(args, '', ['help', 'output=', 'verbose=', + 'counting=', + 'filter=', + 'root=', + 'repository=', + 'linelength=', + 'extensions=', + 'exclude=', + 'headers=', + 'quiet', + 'recursive']) + except getopt.GetoptError: + PrintUsage('Invalid arguments.') + + verbosity = _VerboseLevel() + output_format = _OutputFormat() + filters = '' + counting_style = '' + recursive = False + + for (opt, val) in opts: + if opt == '--help': + PrintUsage(None) + elif opt == '--output': + if val not in ('emacs', 'vs7', 'eclipse', 'junit'): + PrintUsage('The only allowed output formats are emacs, vs7, eclipse ' + 'and junit.') + output_format = val + elif opt == '--verbose': + verbosity = int(val) + elif opt == '--filter': + filters = val + if not filters: + PrintCategories() + elif opt == '--counting': + if val not in ('total', 'toplevel', 'detailed'): + PrintUsage('Valid counting options are total, toplevel, and detailed') + counting_style = val + elif opt == '--root': + global _root + _root = val + elif opt == '--repository': + global _repository + _repository = val + elif opt == '--linelength': + global _line_length + try: + _line_length = int(val) + except ValueError: + PrintUsage('Line length must be digits.') + elif opt == '--exclude': + global _excludes + if not _excludes: + _excludes = set() + _excludes.update(glob.glob(val)) + elif opt == '--extensions': + global _valid_extensions + try: + _valid_extensions = set(val.split(',')) + except ValueError: + PrintUsage('Extensions must be comma seperated list.') + elif opt == '--headers': + global _header_extensions + try: + _header_extensions = set(val.split(',')) + except ValueError: + PrintUsage('Extensions must be comma seperated list.') + elif opt == '--recursive': + recursive = True + elif opt == '--quiet': + global _quiet + _quiet = True + + if not filenames: + PrintUsage('No files were specified.') + + if recursive: + filenames = _ExpandDirectories(filenames) + + if _excludes: + filenames = _FilterExcludedFiles(filenames) + + _SetOutputFormat(output_format) + _SetVerboseLevel(verbosity) + _SetFilters(filters) + _SetCountingStyle(counting_style) + + return filenames + +def _ExpandDirectories(filenames): + """Searches a list of filenames and replaces directories in the list with + all files descending from those directories. Files with extensions not in + the valid extensions list are excluded. + + Args: + filenames: A list of files or directories + + Returns: + A list of all files that are members of filenames or descended from a + directory in filenames + """ + expanded = set() + for filename in filenames: + if not os.path.isdir(filename): + expanded.add(filename) + continue + + for root, _, files in os.walk(filename): + for loopfile in files: + fullname = os.path.join(root, loopfile) + if fullname.startswith('.' + os.path.sep): + fullname = fullname[len('.' + os.path.sep):] + expanded.add(fullname) + + filtered = [] + for filename in expanded: + if os.path.splitext(filename)[1][1:] in GetAllExtensions(): + filtered.append(filename) + + return filtered + +def _FilterExcludedFiles(filenames): + """Filters out files listed in the --exclude command line switch. File paths + in the switch are evaluated relative to the current working directory + """ + exclude_paths = [os.path.abspath(f) for f in _excludes] + return [f for f in filenames if os.path.abspath(f) not in exclude_paths] + +def main(): + filenames = ParseArguments(sys.argv[1:]) + backup_err = sys.stderr + try: + # Change stderr to write with replacement characters so we don't die + # if we try to print something containing non-ASCII characters. + sys.stderr = codecs.StreamReader(sys.stderr, 'replace') + + _cpplint_state.ResetErrorCounts() + for filename in filenames: + ProcessFile(filename, _cpplint_state.verbose_level) + _cpplint_state.PrintErrorCounts() + + if _cpplint_state.output_format == 'junit': + sys.stderr.write(_cpplint_state.FormatJUnitXML()) + + finally: + sys.stderr = backup_err + + sys.exit(_cpplint_state.error_count > 0) + + +if __name__ == '__main__': + main() diff --git a/language_bindings/python/bind_py_cell.cc b/language_bindings/python/bind_py_cell.cc index d2266ec..6d3514f 100644 --- a/language_bindings/python/bind_py_cell.cc +++ b/language_bindings/python/bind_py_cell.cc @@ -1,222 +1,224 @@ /** * @file bind_py_cell.cc * * @author Till Junge * * @date 09 Jan 2018 * * @brief Python bindings for the cell factory function * * Copyright © 2018 Till Junge * * µSpectre 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, 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 Lesser General Public License * along with µSpectre; see the file COPYING. If not, write to the * Free Software Foundation, Inc., 59 Temple Place - Suite 330, * * Boston, MA 02111-1307, USA. * * Additional permission under GNU GPL version 3 section 7 * * If you modify this Program, or any covered work, by linking or combining it * with proprietary FFT implementations or numerical libraries, containing parts * covered by the terms of those libraries' licenses, the licensors of this * Program grant you additional permission to convey the resulting work. */ #include "common/common.hh" #include "common/ccoord_operations.hh" #include "cell/cell_factory.hh" #include "cell/cell_base.hh" #ifdef WITH_FFTWMPI #include "fft/fftwmpi_engine.hh" #endif #ifdef WITH_PFFT #include "fft/pfft_engine.hh" #endif #include #include #include "pybind11/eigen.h" #include #include using namespace muSpectre; // NOLINT // TODO(junge): figure this out namespace py = pybind11; using namespace pybind11::literals; // NOLINT: recommended usage /** * cell factory for specific FFT engine */ #ifdef WITH_MPI template -void add_parallel_cell_factory_helper(py::module &mod, const char *name) { +void add_parallel_cell_factory_helper(py::module & mod, const char * name) { using Ccoord = Ccoord_t; using Rcoord = Rcoord_t; mod.def(name, [](Ccoord res, Rcoord lens, Formulation form, size_t comm) { return make_parallel_cell, FFTEngine>( std::move(res), std::move(lens), std::move(form), std::move(Communicator(MPI_Comm(comm)))); }, "resolutions"_a, "lengths"_a = CcoordOps::get_cube(1.), "formulation"_a = Formulation::finite_strain, "communicator"_a = size_t(MPI_COMM_SELF)); } #endif /** * the cell factory is only bound for default template parameters */ -template void add_cell_factory_helper(py::module &mod) { +template +void add_cell_factory_helper(py::module & mod) { using Ccoord = Ccoord_t; using Rcoord = Rcoord_t; mod.def("CellFactory", [](Ccoord res, Rcoord lens, Formulation form) { return make_cell(std::move(res), std::move(lens), std::move(form)); }, "resolutions"_a, "lengths"_a = CcoordOps::get_cube(1.), "formulation"_a = Formulation::finite_strain); #ifdef WITH_FFTWMPI add_parallel_cell_factory_helper>( mod, "FFTWMPICellFactory"); #endif #ifdef WITH_PFFT add_parallel_cell_factory_helper>(mod, "PFFTCellFactory"); #endif } -void add_cell_factory(py::module &mod) { +void add_cell_factory(py::module & mod) { add_cell_factory_helper(mod); add_cell_factory_helper(mod); } /** * CellBase for which the material and spatial dimension are identical */ -template void add_cell_base_helper(py::module &mod) { +template +void add_cell_base_helper(py::module & mod) { std::stringstream name_stream{}; name_stream << "CellBase" << dim << 'd'; const std::string name = name_stream.str(); using sys_t = CellBase; py::class_(mod, name.c_str()) .def("__len__", &sys_t::size) .def("__iter__", - [](sys_t &s) { return py::make_iterator(s.begin(), s.end()); }) + [](sys_t & s) { return py::make_iterator(s.begin(), s.end()); }) .def("initialise", &sys_t::initialise, "flags"_a = FFT_PlanFlags::estimate) .def( "directional_stiffness", - [](sys_t &cell, py::EigenDRef &v) { + [](sys_t & cell, py::EigenDRef & v) { if ((size_t(v.cols()) != cell.size() || size_t(v.rows()) != dim * dim)) { std::stringstream err{}; err << "need array of shape (" << dim * dim << ", " << cell.size() << ") but got (" << v.rows() << ", " << v.cols() << ")."; throw std::runtime_error(err.str()); } if (!cell.is_initialised()) { cell.initialise(); } const std::string out_name{"temp output for directional stiffness"}; const std::string in_name{"temp input for directional stiffness"}; constexpr bool create_tangent{true}; - auto &K = cell.get_tangent(create_tangent); - auto &input = cell.get_managed_T2_field(in_name); - auto &output = cell.get_managed_T2_field(out_name); + auto & K = cell.get_tangent(create_tangent); + auto & input = cell.get_managed_T2_field(in_name); + auto & output = cell.get_managed_T2_field(out_name); input.eigen() = v; cell.directional_stiffness(K, input, output); return output.eigen(); }, "δF"_a) .def("project", - [](sys_t &cell, py::EigenDRef &v) { + [](sys_t & cell, py::EigenDRef & v) { if ((size_t(v.cols()) != cell.size() || size_t(v.rows()) != dim * dim)) { std::stringstream err{}; err << "need array of shape (" << dim * dim << ", " << cell.size() << ") but got (" << v.rows() << ", " << v.cols() << ")."; throw std::runtime_error(err.str()); } if (!cell.is_initialised()) { cell.initialise(); } const std::string in_name{"temp input for projection"}; - auto &input = cell.get_managed_T2_field(in_name); + auto & input = cell.get_managed_T2_field(in_name); input.eigen() = v; cell.project(input); return input.eigen(); }, "field"_a) .def("get_strain", - [](sys_t &s) { return Eigen::ArrayXXd(s.get_strain().eigen()); }) + [](sys_t & s) { return Eigen::ArrayXXd(s.get_strain().eigen()); }) .def("get_stress", - [](sys_t &s) { return Eigen::ArrayXXd(s.get_stress().eigen()); }) + [](sys_t & s) { return Eigen::ArrayXXd(s.get_stress().eigen()); }) .def_property_readonly("size", &sys_t::size) .def("evaluate_stress_tangent", - [](sys_t &cell, py::EigenDRef &v) { + [](sys_t & cell, py::EigenDRef & v) { if ((size_t(v.cols()) != cell.size() || size_t(v.rows()) != dim * dim)) { std::stringstream err{}; err << "need array of shape (" << dim * dim << ", " << cell.size() << ") but got (" << v.rows() << ", " << v.cols() << ")."; throw std::runtime_error(err.str()); } - auto &strain{cell.get_strain()}; + auto & strain{cell.get_strain()}; strain.eigen() = v; cell.evaluate_stress_tangent(strain); }, "strain"_a) .def("get_projection", &sys_t::get_projection) .def("get_subdomain_resolutions", &sys_t::get_subdomain_resolutions) .def("get_subdomain_locations", &sys_t::get_subdomain_locations) .def("get_domain_resolutions", &sys_t::get_domain_resolutions) .def("get_domain_lengths", &sys_t::get_domain_resolutions); } -void add_cell_base(py::module &mod) { +void add_cell_base(py::module & mod) { py::class_(mod, "Cell") .def("get_globalised_internal_real_array", &Cell::get_globalised_internal_real_array, "unique_name"_a, "Convenience function to copy local (internal) fields of " "materials into a global field. At least one of the materials in " "the cell needs to contain an internal field named " "`unique_name`. If multiple materials contain such a field, they " "all need to be of same scalar type and same number of " "components. This does not work for split pixel cells or " "laminate pixel cells, as they can have multiple entries for the " "same pixel. Pixels for which no field named `unique_name` " "exists get an array of zeros." "\n" "Parameters:\n" "unique_name: fieldname to fill the global field with. At " "least one material must have such a field, or an " "Exception is raised."); add_cell_base_helper(mod); add_cell_base_helper(mod); } -void add_cell(py::module &mod) { +void add_cell(py::module & mod) { add_cell_factory(mod); auto cell{mod.def_submodule("cell")}; cell.doc() = "bindings for cells and cell factories"; add_cell_base(cell); } diff --git a/language_bindings/python/bind_py_common.cc b/language_bindings/python/bind_py_common.cc index cad47ca..ae414a0 100644 --- a/language_bindings/python/bind_py_common.cc +++ b/language_bindings/python/bind_py_common.cc @@ -1,151 +1,156 @@ /** * @file bind_py_common.cc * * @author Till Junge * * @date 08 Jan 2018 * * @brief Python bindings for the common part of µSpectre * * Copyright © 2018 Till Junge * * µSpectre 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, 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 Lesser General Public License * along with µSpectre; see the file COPYING. If not, write to the * Free Software Foundation, Inc., 59 Temple Place - Suite 330, * * Boston, MA 02111-1307, USA. * * Additional permission under GNU GPL version 3 section 7 * * If you modify this Program, or any covered work, by linking or combining it * with proprietary FFT implementations or numerical libraries, containing parts * covered by the terms of those libraries' licenses, the licensors of this * Program grant you additional permission to convey the resulting work. */ #include "common/common.hh" #include "common/ccoord_operations.hh" #include #include #include using namespace muSpectre; // NOLINT // TODO(junge): figure this out namespace py = pybind11; using namespace pybind11::literals; // NOLINT: recommended usage -template void add_get_cube_helper(py::module &mod) { +template +void add_get_cube_helper(py::module & mod) { std::stringstream name{}; name << "get_" << dim << "d_cube"; mod.def(name.str().c_str(), &CcoordOps::get_cube, "size"_a, "return a Ccoord with the value 'size' repeated in each dimension"); } -template void add_get_hermitian_helper(py::module &mod) { +template +void add_get_hermitian_helper(py::module & mod) { mod.def("get_hermitian_sizes", &CcoordOps::get_hermitian_sizes, "full_sizes"_a, "return the hermitian sizes corresponding to the true sizes"); } -template void add_get_ccoord_helper(py::module &mod) { +template +void add_get_ccoord_helper(py::module & mod) { using Ccoord = Ccoord_t; mod.def( "get_domain_ccoord", [](Ccoord resolutions, Dim_t index) { return CcoordOps::get_ccoord(resolutions, Ccoord{}, index); }, "resolutions"_a, "i"_a, "return the cell coordinate corresponding to the i'th cell in a grid of " "shape resolutions"); } -void add_get_cube(py::module &mod) { +void add_get_cube(py::module & mod) { add_get_cube_helper(mod); add_get_cube_helper(mod); add_get_cube_helper(mod); add_get_cube_helper(mod); add_get_hermitian_helper(mod); add_get_hermitian_helper(mod); add_get_ccoord_helper(mod); add_get_ccoord_helper(mod); } -template void add_get_index_helper(py::module &mod) { +template +void add_get_index_helper(py::module & mod) { using Ccoord = Ccoord_t; mod.def("get_domain_index", [](Ccoord sizes, Ccoord ccoord) { return CcoordOps::get_index(sizes, Ccoord{}, ccoord); }, "sizes"_a, "ccoord"_a, "return the linear index corresponding to grid point 'ccoord' in a " "grid of size 'sizes'"); } -void add_get_index(py::module &mod) { +void add_get_index(py::module & mod) { add_get_index_helper(mod); add_get_index_helper(mod); } -template void add_Pixels_helper(py::module &mod) { +template +void add_Pixels_helper(py::module & mod) { std::stringstream name{}; name << "Pixels" << dim << "d"; using Ccoord = Ccoord_t; py::class_> Pixels(mod, name.str().c_str()); Pixels.def(py::init()); } -void add_Pixels(py::module &mod) { +void add_Pixels(py::module & mod) { add_Pixels_helper(mod); add_Pixels_helper(mod); } -void add_common(py::module &mod) { +void add_common(py::module & mod) { py::enum_(mod, "Formulation") .value("finite_strain", Formulation::finite_strain) .value("small_strain", Formulation::small_strain); py::enum_(mod, "StressMeasure") .value("Cauchy", StressMeasure::Cauchy) .value("PK1", StressMeasure::PK1) .value("PK2", StressMeasure::PK2) .value("Kirchhoff", StressMeasure::Kirchhoff) .value("Biot", StressMeasure::Biot) .value("Mandel", StressMeasure::Mandel) .value("no_stress_", StressMeasure::no_stress_); py::enum_(mod, "StrainMeasure") .value("Gradient", StrainMeasure::Gradient) .value("Infinitesimal", StrainMeasure::Infinitesimal) .value("GreenLagrange", StrainMeasure::GreenLagrange) .value("Biot", StrainMeasure::Biot) .value("Log", StrainMeasure::Log) .value("Almansi", StrainMeasure::Almansi) .value("RCauchyGreen", StrainMeasure::RCauchyGreen) .value("LCauchyGreen", StrainMeasure::LCauchyGreen) .value("no_strain_", StrainMeasure::no_strain_); py::enum_(mod, "FFT_PlanFlags") .value("estimate", FFT_PlanFlags::estimate) .value("measure", FFT_PlanFlags::measure) .value("patient", FFT_PlanFlags::patient); mod.def("banner", &banner, "name"_a, "year"_a, "copyright_holder"_a); add_get_cube(mod); add_Pixels(mod); add_get_index(mod); } diff --git a/language_bindings/python/bind_py_declarations.hh b/language_bindings/python/bind_py_declarations.hh index 8115e6e..c342f82 100644 --- a/language_bindings/python/bind_py_declarations.hh +++ b/language_bindings/python/bind_py_declarations.hh @@ -1,49 +1,49 @@ /** * @file bind_py_common.hh * * @author Till Junge * * @date 12 Jan 2018 * * @brief header for python bindings for the common part of µSpectre * * Copyright © 2018 Till Junge * * µSpectre 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, 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 Lesser General Public License * along with µSpectre; see the file COPYING. If not, write to the * Free Software Foundation, Inc., 59 Temple Place - Suite 330, * * Boston, MA 02111-1307, USA. * * Additional permission under GNU GPL version 3 section 7 * * If you modify this Program, or any covered work, by linking or combining it * with proprietary FFT implementations or numerical libraries, containing parts * covered by the terms of those libraries' licenses, the licensors of this * Program grant you additional permission to convey the resulting work. */ #ifndef LANGUAGE_BINDINGS_PYTHON_BIND_PY_DECLARATIONS_HH_ #define LANGUAGE_BINDINGS_PYTHON_BIND_PY_DECLARATIONS_HH_ #include namespace py = pybind11; -void add_common(py::module &mod); -void add_cell(py::module &mod); -void add_material(py::module &mod); -void add_solvers(py::module &mod); -void add_fft_engines(py::module &mod); -void add_projections(py::module &submodule); -void add_field_collections(py::module &submodule); +void add_common(py::module & mod); +void add_cell(py::module & mod); +void add_material(py::module & mod); +void add_solvers(py::module & mod); +void add_fft_engines(py::module & mod); +void add_projections(py::module & submodule); +void add_field_collections(py::module & submodule); #endif // LANGUAGE_BINDINGS_PYTHON_BIND_PY_DECLARATIONS_HH_ diff --git a/language_bindings/python/bind_py_fftengine.cc b/language_bindings/python/bind_py_fftengine.cc index 54e6591..00044e6 100644 --- a/language_bindings/python/bind_py_fftengine.cc +++ b/language_bindings/python/bind_py_fftengine.cc @@ -1,118 +1,118 @@ /** * @file bind_py_fftengine.cc * * @author Till Junge * * @date 17 Jan 2018 * * @brief Python bindings for the FFT engines * * Copyright © 2018 Till Junge * * µSpectre 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, 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 Lesser General Public License * along with µSpectre; see the file COPYING. If not, write to the * Free Software Foundation, Inc., 59 Temple Place - Suite 330, * * Boston, MA 02111-1307, USA. * * Additional permission under GNU GPL version 3 section 7 * * If you modify this Program, or any covered work, by linking or combining it * with proprietary FFT implementations or numerical libraries, containing parts * covered by the terms of those libraries' licenses, the licensors of this * Program grant you additional permission to convey the resulting work. */ #include "fft/fftw_engine.hh" #ifdef WITH_FFTWMPI #include "fft/fftwmpi_engine.hh" #endif #ifdef WITH_PFFT #include "fft/pfft_engine.hh" #endif #include "bind_py_declarations.hh" #include #include #include using namespace muSpectre; // NOLINT // TODO(junge): figure this out namespace py = pybind11; using namespace pybind11::literals; // NOLINT: recommended usage template -void add_engine_helper(py::module &mod, std::string name) { +void add_engine_helper(py::module & mod, std::string name) { using Ccoord = Ccoord_t; using ArrayXXc = Eigen::Array; py::class_(mod, name.c_str()) #ifdef WITH_MPI .def(py::init([](Ccoord res, Dim_t nb_components, size_t comm) { return new Engine(res, nb_components, std::move(Communicator(MPI_Comm(comm)))); }), "resolutions"_a, "nb_components"_a, "communicator"_a = size_t(MPI_COMM_SELF)) #else .def(py::init()) #endif .def("fft", - [](Engine &eng, py::EigenDRef v) { + [](Engine & eng, py::EigenDRef v) { using Coll_t = typename Engine::GFieldCollection_t; using Field_t = typename Engine::Field_t; Coll_t coll{}; coll.initialise(eng.get_subdomain_resolutions(), eng.get_subdomain_locations()); - Field_t &temp{make_field("temp_field", coll, - eng.get_nb_components())}; + Field_t & temp{make_field("temp_field", coll, + eng.get_nb_components())}; temp.eigen() = v; return ArrayXXc{eng.fft(temp).eigen()}; }, "array"_a) .def("ifft", - [](Engine &eng, py::EigenDRef v) { + [](Engine & eng, py::EigenDRef v) { using Coll_t = typename Engine::GFieldCollection_t; using Field_t = typename Engine::Field_t; Coll_t coll{}; coll.initialise(eng.get_subdomain_resolutions(), eng.get_subdomain_locations()); - Field_t &temp{make_field("temp_field", coll, - eng.get_nb_components())}; + Field_t & temp{make_field("temp_field", coll, + eng.get_nb_components())}; eng.get_work_space().eigen() = v; eng.ifft(temp); return Eigen::ArrayXXd{temp.eigen()}; }, "array"_a) .def("initialise", &Engine::initialise, "flags"_a = FFT_PlanFlags::estimate) .def("normalisation", &Engine::normalisation) .def("get_subdomain_resolutions", &Engine::get_subdomain_resolutions) .def("get_subdomain_locations", &Engine::get_subdomain_locations) .def("get_fourier_resolutions", &Engine::get_fourier_resolutions) .def("get_fourier_locations", &Engine::get_fourier_locations) .def("get_domain_resolutions", &Engine::get_domain_resolutions); } -void add_fft_engines(py::module &mod) { +void add_fft_engines(py::module & mod) { auto fft{mod.def_submodule("fft")}; fft.doc() = "bindings for µSpectre's fft engines"; add_engine_helper, twoD>(fft, "FFTW_2d"); add_engine_helper, threeD>(fft, "FFTW_3d"); #ifdef WITH_FFTWMPI add_engine_helper, twoD>(fft, "FFTWMPI_2d"); add_engine_helper, threeD>(fft, "FFTWMPI_3d"); #endif #ifdef WITH_PFFT add_engine_helper, twoD>(fft, "PFFT_2d"); add_engine_helper, threeD>(fft, "PFFT_3d"); #endif add_projections(fft); } diff --git a/language_bindings/python/bind_py_field_collection.cc b/language_bindings/python/bind_py_field_collection.cc index 3d29f8f..6d0b219 100644 --- a/language_bindings/python/bind_py_field_collection.cc +++ b/language_bindings/python/bind_py_field_collection.cc @@ -1,227 +1,229 @@ /** * file bind_py_field_collection.cc * * @author Till Junge * * @date 05 Jul 2018 * * @brief Python bindings for µSpectre field collections * * @section LICENSE * * Copyright © 2018 Till Junge * * µSpectre 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, 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 Lesser General Public License * along with µSpectre; see the file COPYING. If not, write to the * Free Software Foundation, Inc., 59 Temple Place - Suite 330, * * Boston, MA 02111-1307, USA. * * Additional permission under GNU GPL version 3 section 7 * * If you modify this Program, or any covered work, by linking or combining it * with proprietary FFT implementations or numerical libraries, containing parts * covered by the terms of those libraries' licenses, the licensors of this * Program grant you additional permission to convey the resulting work. */ #include "common/common.hh" #include "common/field.hh" #include "common/field_collection.hh" #include #include #include #include #include using namespace muSpectre; // NOLINT // TODO(junge): figure this out namespace py = pybind11; using namespace pybind11::literals; // NOLINT: recommended usage template -void add_field_collection(py::module &mod) { +void add_field_collection(py::module & mod) { std::stringstream name_stream{}; name_stream << "_" << (FieldCollectionDerived::Global ? "Global" : "Local") << "FieldCollection_" << Dim << 'd'; const auto name{name_stream.str()}; using FC_t = FieldCollectionBase; py::class_(mod, name.c_str()) .def("get_real_field", [](FC_t & field_collection, std::string unique_name) -> typename FC_t::template TypedField_t & { return field_collection.template get_typed_field( unique_name); }, "unique_name"_a, py::return_value_policy::reference_internal) .def("get_int_field", [](FC_t & field_collection, std::string unique_name) -> typename FC_t::template TypedField_t & { return field_collection.template get_typed_field(unique_name); }, "unique_name"_a, py::return_value_policy::reference_internal) .def("get_uint_field", [](FC_t & field_collection, std::string unique_name) -> typename FC_t::template TypedField_t & { return field_collection.template get_typed_field( unique_name); }, "unique_name"_a, py::return_value_policy::reference_internal) .def("get_complex_field", [](FC_t & field_collection, std::string unique_name) -> typename FC_t::template TypedField_t & { return field_collection.template get_typed_field( unique_name); }, "unique_name"_a, py::return_value_policy::reference_internal) .def("get_real_statefield", [](FC_t & field_collection, std::string unique_name) -> typename FC_t::template TypedStateField_t & { return field_collection.template get_typed_statefield( unique_name); }, "unique_name"_a, py::return_value_policy::reference_internal) .def("get_int_statefield", [](FC_t & field_collection, std::string unique_name) -> typename FC_t::template TypedStateField_t & { return field_collection.template get_typed_statefield( unique_name); }, "unique_name"_a, py::return_value_policy::reference_internal) .def("get_uint_statefield", [](FC_t & field_collection, std::string unique_name) -> typename FC_t::template TypedStateField_t & { return field_collection.template get_typed_statefield( unique_name); }, "unique_name"_a, py::return_value_policy::reference_internal) .def("get_complex_statefield", [](FC_t & field_collection, std::string unique_name) -> typename FC_t::template TypedStateField_t & { return field_collection.template get_typed_statefield( unique_name); }, "unique_name"_a, py::return_value_policy::reference_internal) .def_property_readonly( "field_names", &FC_t::get_field_names, "returns the names of all fields in this collection") .def_property_readonly("statefield_names", &FC_t::get_statefield_names, "returns the names of all state fields in this " "collection"); } template -void add_field(py::module &mod, std::string dtype_name) { +void add_field(py::module & mod, std::string dtype_name) { using Field_t = TypedField; std::stringstream name_stream{}; name_stream << (FieldCollection::Global ? "Global" : "Local") << "Field" << dtype_name << "_" << FieldCollection::spatial_dim(); std::string name{name_stream.str()}; using Ref_t = py::EigenDRef>; py::class_(mod, name.c_str()) - .def_property("array", [](Field_t &field) { return field.eigen(); }, - [](Field_t &field, Ref_t mat) { field.eigen() = mat; }, + .def_property("array", [](Field_t & field) { return field.eigen(); }, + [](Field_t & field, Ref_t mat) { field.eigen() = mat; }, "array of stored data") - .def_property_readonly("array", - [](const Field_t &field) { return field.eigen(); }, - "array of stored data") - .def_property("vector", [](Field_t &field) { return field.eigenvec(); }, - [](Field_t &field, Ref_t mat) { field.eigen() = mat; }, + .def_property_readonly( + "array", [](const Field_t & field) { return field.eigen(); }, + "array of stored data") + .def_property("vector", [](Field_t & field) { return field.eigenvec(); }, + [](Field_t & field, Ref_t mat) { field.eigen() = mat; }, "flattened array of stored data") .def_property_readonly( - "vector", [](const Field_t &field) { return field.eigenvec(); }, + "vector", [](const Field_t & field) { return field.eigenvec(); }, "flattened array of stored data"); } template -void add_field_helper(py::module &mod) { +void add_field_helper(py::module & mod) { std::stringstream name_stream{}; name_stream << (FieldCollection::Global ? "Global" : "Local") << "Field" << "_" << Dim; std::string name{name_stream.str()}; using Field_t = internal::FieldBase; py::class_(mod, name.c_str()) .def_property_readonly("name", &Field_t::get_name, "field name") .def_property_readonly("collection", &Field_t::get_collection, "Collection containing this field") .def_property_readonly("nb_components", &Field_t::get_nb_components, "number of scalars stored per pixel in this field") - .def_property_readonly( - "stored_type", - [](const Field_t &field) { return field.get_stored_typeid().name(); }, - "fundamental type of scalars stored in this field") + .def_property_readonly("stored_type", + [](const Field_t & field) { + return field.get_stored_typeid().name(); + }, + "fundamental type of scalars stored in this field") .def_property_readonly("size", &Field_t::size, "number of pixels in this field") .def("set_zero", &Field_t::set_zero, "Set all components in the field to zero"); add_field(mod, "Real"); add_field(mod, "Int"); } template -void add_statefield(py::module &mod, std::string dtype_name) { +void add_statefield(py::module & mod, std::string dtype_name) { using StateField_t = TypedStateField; std::stringstream name_stream{}; name_stream << (FieldCollection::Global ? "Global" : "Local") << "StateField" << dtype_name << "_" << FieldCollection::spatial_dim(); std::string name{name_stream.str()}; py::class_(mod, name.c_str()) .def("get_current_field", &StateField_t::get_current_field, "returns the current field value", py::return_value_policy::reference_internal) .def("get_old_field", &StateField_t::get_old_field, "nb_steps_ago"_a = 1, "returns the value this field held 'nb_steps_ago' steps ago", py::return_value_policy::reference_internal); } template -void add_statefield_helper(py::module &mod) { +void add_statefield_helper(py::module & mod) { std::stringstream name_stream{}; name_stream << (FieldCollection::Global ? "Global" : "Local") << "StateField" << "_" << Dim; std::string name{name_stream.str()}; using StateField_t = StateFieldBase; py::class_(mod, name.c_str()) .def_property_readonly("prefix", &StateField_t::get_prefix, "state field prefix") .def_property_readonly("collection", &StateField_t::get_collection, "Collection containing this field") .def_property_readonly("nb_memory", &StateField_t::get_nb_memory, "number of old states stored") .def_property_readonly( "stored_type", - [](const StateField_t &field) { + [](const StateField_t & field) { return field.get_stored_typeid().name(); }, "fundamental type of scalars stored in this field"); add_statefield(mod, "Real"); add_statefield(mod, "Int"); } -template void add_field_collection_helper(py::module &mod) { +template +void add_field_collection_helper(py::module & mod) { add_field_helper>(mod); add_field_helper>(mod); add_statefield_helper>(mod); add_statefield_helper>(mod); add_field_collection>(mod); add_field_collection>(mod); } -void add_field_collections(py::module &mod) { +void add_field_collections(py::module & mod) { add_field_collection_helper(mod); add_field_collection_helper(mod); } diff --git a/language_bindings/python/bind_py_material.cc b/language_bindings/python/bind_py_material.cc index 5cada0d..c8a1c49 100644 --- a/language_bindings/python/bind_py_material.cc +++ b/language_bindings/python/bind_py_material.cc @@ -1,177 +1,183 @@ /** * @file bind_py_material.cc * * @author Till Junge * * @date 09 Jan 2018 * * @brief python bindings for µSpectre's materials * * Copyright © 2018 Till Junge * * µSpectre 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, 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 Lesser General Public License * along with µSpectre; see the file COPYING. If not, write to the * Free Software Foundation, Inc., 59 Temple Place - Suite 330, * * Boston, MA 02111-1307, USA. * * Additional permission under GNU GPL version 3 section 7 * * If you modify this Program, or any covered work, by linking or combining it * with proprietary FFT implementations or numerical libraries, containing parts * covered by the terms of those libraries' licenses, the licensors of this * Program grant you additional permission to convey the resulting work. */ #include "common/common.hh" #include "materials/material_linear_elastic1.hh" #include "materials/material_linear_elastic2.hh" #include "materials/material_linear_elastic3.hh" #include "materials/material_linear_elastic4.hh" #include "cell/cell_base.hh" #include "common/field_collection.hh" #include #include #include #include #include using namespace muSpectre; // NOLINT // TODO(junge): figure this out namespace py = pybind11; using namespace pybind11::literals; // NOLINT: recommended usage /** * python binding for the optionally objective form of Hooke's law */ -template void add_material_linear_elastic1_helper(py::module &mod) { +template +void add_material_linear_elastic1_helper(py::module & mod) { std::stringstream name_stream{}; name_stream << "MaterialLinearElastic1_" << dim << 'd'; const auto name{name_stream.str()}; using Mat_t = MaterialLinearElastic1; using Sys_t = CellBase; py::class_>(mod, name.c_str()) .def_static("make", - [](Sys_t &sys, std::string n, Real e, Real p) -> Mat_t & { + [](Sys_t & sys, std::string n, Real e, Real p) -> Mat_t & { return Mat_t::make(sys, n, e, p); }, "cell"_a, "name"_a, "Young"_a, "Poisson"_a, py::return_value_policy::reference, py::keep_alive<1, 0>()) .def("add_pixel", - [](Mat_t &mat, Ccoord_t pix) { mat.add_pixel(pix); }, "pixel"_a) + [](Mat_t & mat, Ccoord_t pix) { mat.add_pixel(pix); }, + "pixel"_a) .def("size", &Mat_t::size); } -template void add_material_linear_elastic2_helper(py::module &mod) { +template +void add_material_linear_elastic2_helper(py::module & mod) { std::stringstream name_stream{}; name_stream << "MaterialLinearElastic2_" << dim << 'd'; const auto name{name_stream.str()}; using Mat_t = MaterialLinearElastic2; using Sys_t = CellBase; py::class_>(mod, name.c_str()) .def_static("make", - [](Sys_t &sys, std::string n, Real e, Real p) -> Mat_t & { + [](Sys_t & sys, std::string n, Real e, Real p) -> Mat_t & { return Mat_t::make(sys, n, e, p); }, "cell"_a, "name"_a, "Young"_a, "Poisson"_a, py::return_value_policy::reference, py::keep_alive<1, 0>()) .def("add_pixel", - [](Mat_t &mat, Ccoord_t pix, - py::EigenDRef &eig) { + [](Mat_t & mat, Ccoord_t pix, + py::EigenDRef & eig) { Eigen::Matrix eig_strain{eig}; mat.add_pixel(pix, eig_strain); }, "pixel"_a, "eigenstrain"_a) .def("size", &Mat_t::size); } -template void add_material_linear_elastic3_helper(py::module &mod) { +template +void add_material_linear_elastic3_helper(py::module & mod) { std::stringstream name_stream{}; name_stream << "MaterialLinearElastic3_" << dim << 'd'; const auto name{name_stream.str()}; using Mat_t = MaterialLinearElastic3; using Sys_t = CellBase; py::class_>(mod, name.c_str()) .def(py::init(), "name"_a) .def_static("make", - [](Sys_t &sys, std::string n) -> Mat_t & { + [](Sys_t & sys, std::string n) -> Mat_t & { return Mat_t::make(sys, n); }, "cell"_a, "name"_a, py::return_value_policy::reference, py::keep_alive<1, 0>()) .def("add_pixel", - [](Mat_t &mat, Ccoord_t pix, Real Young, Real Poisson) { + [](Mat_t & mat, Ccoord_t pix, Real Young, Real Poisson) { mat.add_pixel(pix, Young, Poisson); }, "pixel"_a, "Young"_a, "Poisson"_a) .def("size", &Mat_t::size); } -template void add_material_linear_elastic4_helper(py::module &mod) { +template +void add_material_linear_elastic4_helper(py::module & mod) { std::stringstream name_stream{}; name_stream << "MaterialLinearElastic4_" << dim << 'd'; const auto name{name_stream.str()}; using Mat_t = MaterialLinearElastic4; using Sys_t = CellBase; py::class_>(mod, name.c_str()) .def(py::init(), "name"_a) .def_static("make", - [](Sys_t &sys, std::string n) -> Mat_t & { + [](Sys_t & sys, std::string n) -> Mat_t & { return Mat_t::make(sys, n); }, "cell"_a, "name"_a, py::return_value_policy::reference, py::keep_alive<1, 0>()) .def("add_pixel", - [](Mat_t &mat, Ccoord_t pix, Real Young, Real Poisson) { + [](Mat_t & mat, Ccoord_t pix, Real Young, Real Poisson) { mat.add_pixel(pix, Young, Poisson); }, "pixel"_a, "Young"_a, "Poisson"_a) .def("size", &Mat_t::size); } -template void add_material_helper(py::module &mod) { +template +void add_material_helper(py::module & mod) { std::stringstream name_stream{}; name_stream << "Material_" << dim << 'd'; const std::string name{name_stream.str()}; using Mat_t = MaterialBase; using FC_t = LocalFieldCollection; using FCBase_t = FieldCollectionBase; py::class_(mod, name.c_str()) .def_property_readonly("collection", - [](Mat_t &material) -> FCBase_t & { + [](Mat_t & material) -> FCBase_t & { return material.get_collection(); }, "returns the field collection containing internal " "fields of this material", py::return_value_policy::reference_internal); add_material_linear_elastic1_helper(mod); add_material_linear_elastic2_helper(mod); add_material_linear_elastic3_helper(mod); add_material_linear_elastic4_helper(mod); } -void add_material(py::module &mod) { +void add_material(py::module & mod) { auto material{mod.def_submodule("material")}; material.doc() = "bindings for constitutive laws"; add_material_helper(material); add_material_helper(material); } diff --git a/language_bindings/python/bind_py_projections.cc b/language_bindings/python/bind_py_projections.cc index 0909c49..36d0268 100644 --- a/language_bindings/python/bind_py_projections.cc +++ b/language_bindings/python/bind_py_projections.cc @@ -1,183 +1,183 @@ /** * @file bind_py_projections.cc * * @author Till Junge * * @date 18 Jan 2018 * * @brief Python bindings for the Projection operators * * Copyright © 2018 Till Junge * * µSpectre 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, 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 Lesser General Public License * along with µSpectre; see the file COPYING. If not, write to the * Free Software Foundation, Inc., 59 Temple Place - Suite 330, * * Boston, MA 02111-1307, USA. * * Additional permission under GNU GPL version 3 section 7 * * If you modify this Program, or any covered work, by linking or combining it * with proprietary FFT implementations or numerical libraries, containing parts * covered by the terms of those libraries' licenses, the licensors of this * Program grant you additional permission to convey the resulting work. */ #include "fft/projection_small_strain.hh" #include "fft/projection_finite_strain.hh" #include "fft/projection_finite_strain_fast.hh" #include "fft/fftw_engine.hh" #ifdef WITH_FFTWMPI #include "fft/fftwmpi_engine.hh" #endif #ifdef WITH_PFFT #include "fft/pfft_engine.hh" #endif #include #include #include #include #include using namespace muSpectre; // NOLINT // TODO(junge): figure this out namespace py = pybind11; using namespace pybind11::literals; // NOLINT: recommended usage /** * "Trampoline" class for handling the pure virtual methods, see * [http://pybind11.readthedocs.io/en/stable/advanced/classes.html#overriding-virtual-functions-in-python] * for details */ template class PyProjectionBase : public ProjectionBase { public: //! base class using Parent = ProjectionBase; //! field type on which projection is applied using Field_t = typename Parent::Field_t; - void apply_projection(Field_t &field) override { + void apply_projection(Field_t & field) override { PYBIND11_OVERLOAD_PURE(void, Parent, apply_projection, field); } Eigen::Map get_operator() override { PYBIND11_OVERLOAD_PURE(Eigen::Map, Parent, get_operator); } }; template -void add_proj_helper(py::module &mod, std::string name_start) { +void add_proj_helper(py::module & mod, std::string name_start) { using Ccoord = Ccoord_t; using Rcoord = Rcoord_t; using Field_t = typename Proj::Field_t; static_assert(DimS == DimM, "currently only for DimS==DimM"); std::stringstream name{}; name << name_start << '_' << DimS << 'd'; py::class_(mod, name.str().c_str()) #ifdef WITH_MPI - .def(py::init([](Ccoord res, Rcoord lengths, const std::string &fft, + .def(py::init([](Ccoord res, Rcoord lengths, const std::string & fft, size_t comm) { if (fft == "fftw") { auto engine = std::make_unique>( res, Proj::NbComponents(), std::move(Communicator(MPI_Comm(comm)))); return Proj(std::move(engine), lengths); #else - .def(py::init([](Ccoord res, Rcoord lengths, const std::string &fft) { + .def(py::init([](Ccoord res, Rcoord lengths, const std::string & fft) { if (fft == "fftw") { auto engine = std::make_unique>( res, Proj::NbComponents()); return Proj(std::move(engine), lengths); #endif #ifdef WITH_FFTWMPI } else if (fft == "fftwmpi") { auto engine = std::make_unique>( res, Proj::NbComponents(), std::move(Communicator(MPI_Comm(comm)))); return Proj(std::move(engine), lengths); #endif #ifdef WITH_PFFT } else if (fft == "pfft") { auto engine = std::make_unique>( res, Proj::NbComponents(), std::move(Communicator(MPI_Comm(comm)))); return Proj(std::move(engine), lengths); #endif } else { throw std::runtime_error("Unknown FFT engine '" + fft + "' specified."); } }), "resolutions"_a, "lengths"_a, #ifdef WITH_MPI "fft"_a = "fftw", "communicator"_a = size_t(MPI_COMM_SELF)) #else "fft"_a = "fftw") #endif .def("initialise", &Proj::initialise, "flags"_a = FFT_PlanFlags::estimate, "initialises the fft engine (plan the transform)") .def("apply_projection", - [](Proj &proj, py::EigenDRef v) { + [](Proj & proj, py::EigenDRef v) { typename FFTEngineBase::GFieldCollection_t coll{}; Eigen::Index subdomain_size = CcoordOps::get_size(proj.get_subdomain_resolutions()); if (v.rows() != DimS * DimM || v.cols() != subdomain_size) { throw std::runtime_error("Expected input array of shape (" + std::to_string(DimS * DimM) + ", " + std::to_string(subdomain_size) + "), but input array has shape (" + std::to_string(v.rows()) + ", " + std::to_string(v.cols()) + ")."); } coll.initialise(proj.get_subdomain_resolutions(), proj.get_subdomain_locations()); - Field_t &temp{make_field("temp_field", coll, - proj.get_nb_components())}; + Field_t & temp{make_field("temp_field", coll, + proj.get_nb_components())}; temp.eigen() = v; proj.apply_projection(temp); return Eigen::ArrayXXd{temp.eigen()}; }) .def("get_operator", &Proj::get_operator) .def( "get_formulation", &Proj::get_formulation, "return a Formulation enum indicating whether the projection is small" " or finite strain") .def("get_subdomain_resolutions", &Proj::get_subdomain_resolutions) .def("get_subdomain_locations", &Proj::get_subdomain_locations) .def("get_domain_resolutions", &Proj::get_domain_resolutions) .def("get_domain_lengths", &Proj::get_domain_resolutions); } -void add_proj_dispatcher(py::module &mod) { +void add_proj_dispatcher(py::module & mod) { add_proj_helper, twoD>( mod, "ProjectionSmallStrain"); add_proj_helper, threeD>( mod, "ProjectionSmallStrain"); add_proj_helper, twoD>( mod, "ProjectionFiniteStrain"); add_proj_helper, threeD>( mod, "ProjectionFiniteStrain"); add_proj_helper, twoD>( mod, "ProjectionFiniteStrainFast"); add_proj_helper, threeD>( mod, "ProjectionFiniteStrainFast"); } -void add_projections(py::module &mod) { add_proj_dispatcher(mod); } +void add_projections(py::module & mod) { add_proj_dispatcher(mod); } diff --git a/language_bindings/python/bind_py_solvers.cc b/language_bindings/python/bind_py_solvers.cc index de49049..2dddd31 100644 --- a/language_bindings/python/bind_py_solvers.cc +++ b/language_bindings/python/bind_py_solvers.cc @@ -1,139 +1,139 @@ /** * @file bind_py_solver.cc * * @author Till Junge * * @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 Lesser 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 Lesser General Public License * along with µSpectre; see the file COPYING. If not, write to the * Free Software Foundation, Inc., 59 Temple Place - Suite 330, * * Boston, MA 02111-1307, USA. * * Additional permission under GNU GPL version 3 section 7 * * If you modify this Program, or any covered work, by linking or combining it * with proprietary FFT implementations or numerical libraries, containing parts * covered by the terms of those libraries' licenses, the licensors of this * Program grant you additional permission to convey the resulting work. */ #include "common/common.hh" #include "solver/solvers.hh" #include "solver/solver_cg.hh" #include "solver/solver_eigen.hh" #include #include #include using namespace muSpectre; // NOLINT // TODO(junge): figure this out namespace py = pybind11; using namespace pybind11::literals; // NOLINT: recommended usage /** * Solvers instanciated for cells with equal spatial and material dimension */ template -void add_iterative_solver_helper(py::module &mod, std::string name) { +void add_iterative_solver_helper(py::module & mod, std::string name) { py::class_(mod, name.c_str()) .def(py::init(), "cell"_a, "tol"_a, "maxiter"_a, "verbose"_a = false) .def("name", &Solver::get_name); } -void add_iterative_solver(py::module &mod) { +void add_iterative_solver(py::module & mod) { std::stringstream name{}; name << "SolverBase"; py::class_(mod, name.str().c_str()); add_iterative_solver_helper(mod, "SolverCG"); add_iterative_solver_helper(mod, "SolverCGEigen"); add_iterative_solver_helper(mod, "SolverGMRESEigen"); add_iterative_solver_helper(mod, "SolverBiCGSTABEigen"); add_iterative_solver_helper(mod, "SolverDGMRESEigen"); add_iterative_solver_helper(mod, "SolverMINRESEigen"); } -void add_newton_cg_helper(py::module &mod) { +void add_newton_cg_helper(py::module & mod) { const char name[]{"newton_cg"}; using solver = SolverBase; using grad = py::EigenDRef; using grad_vec = LoadSteps_t; mod.def(name, - [](Cell &s, const grad &g, solver &so, Real nt, Real eqt, + [](Cell & s, const grad & g, solver & so, Real nt, Real eqt, Dim_t verb) -> OptimizeResult { Eigen::MatrixXd tmp{g}; return newton_cg(s, tmp, so, nt, eqt, verb); }, "cell"_a, "ΔF₀"_a, "solver"_a, "newton_tol"_a, "equil_tol"_a, "verbose"_a = 0); mod.def(name, - [](Cell &s, const grad_vec &g, solver &so, Real nt, Real eqt, + [](Cell & s, const grad_vec & g, solver & so, Real nt, Real eqt, Dim_t verb) -> std::vector { return newton_cg(s, g, so, nt, eqt, verb); }, "cell"_a, "ΔF₀"_a, "solver"_a, "newton_tol"_a, "equilibrium_tol"_a, "verbose"_a = 0); } -void add_de_geus_helper(py::module &mod) { +void add_de_geus_helper(py::module & mod) { const char name[]{"de_geus"}; using solver = SolverBase; using grad = py::EigenDRef; using grad_vec = LoadSteps_t; mod.def(name, - [](Cell &s, const grad &g, solver &so, Real nt, Real eqt, + [](Cell & s, const grad & g, solver & so, Real nt, Real eqt, Dim_t verb) -> OptimizeResult { Eigen::MatrixXd tmp{g}; return de_geus(s, tmp, so, nt, eqt, verb); }, "cell"_a, "ΔF₀"_a, "solver"_a, "newton_tol"_a, "equilibrium_tol"_a, "verbose"_a = 0); mod.def(name, - [](Cell &s, const grad_vec &g, solver &so, Real nt, Real eqt, + [](Cell & s, const grad_vec & g, solver & so, Real nt, Real eqt, Dim_t verb) -> std::vector { return de_geus(s, g, so, nt, eqt, verb); }, "cell"_a, "ΔF₀"_a, "solver"_a, "newton_tol"_a, "equilibrium_tol"_a, "verbose"_a = 0); } -void add_solver_helper(py::module &mod) { +void add_solver_helper(py::module & mod) { add_newton_cg_helper(mod); add_de_geus_helper(mod); } -void add_solvers(py::module &mod) { +void add_solvers(py::module & mod) { auto solvers{mod.def_submodule("solvers")}; solvers.doc() = "bindings for solvers"; py::class_(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(solvers); } diff --git a/src/cell/cell_base.cc b/src/cell/cell_base.cc index 652fd53..1474f58 100644 --- a/src/cell/cell_base.cc +++ b/src/cell/cell_base.cc @@ -1,532 +1,513 @@ /** * @file cell_base.cc * * @author Till Junge * * @date 01 Nov 2017 * * @brief Implementation for cell base class * * Copyright © 2017 Till Junge * * µSpectre 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, 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 Lesser General Public License * along with µSpectre; see the file COPYING. If not, write to the * Free Software Foundation, Inc., 59 Temple Place - Suite 330, * * Boston, MA 02111-1307, USA. * * Additional permission under GNU GPL version 3 section 7 * * If you modify this Program, or any covered work, by linking or combining it * with proprietary FFT implementations or numerical libraries, containing parts * covered by the terms of those libraries' licenses, the licensors of this * Program grant you additional permission to convey the resulting work. */ #include "cell/cell_base.hh" #include "common/ccoord_operations.hh" #include "common/iterators.hh" #include "common/tensor_algebra.hh" #include #include #include #include namespace muSpectre { /* ---------------------------------------------------------------------- */ template CellBase::CellBase(Projection_ptr projection_) - :subdomain_resolutions{projection_->get_subdomain_resolutions()}, - subdomain_locations{projection_->get_subdomain_locations()}, - domain_resolutions{projection_->get_domain_resolutions()}, - pixels(subdomain_resolutions, subdomain_locations), - domain_lengths{projection_->get_domain_lengths()}, - fields{std::make_unique()}, - F{make_field("Gradient", *this->fields)}, - P{make_field("Piola-Kirchhoff-1", *this->fields)}, - projection{std::move(projection_)} - { + : subdomain_resolutions{projection_->get_subdomain_resolutions()}, + subdomain_locations{projection_->get_subdomain_locations()}, + domain_resolutions{projection_->get_domain_resolutions()}, + pixels(subdomain_resolutions, subdomain_locations), + domain_lengths{projection_->get_domain_lengths()}, + fields{std::make_unique()}, + F{make_field("Gradient", *this->fields)}, + P{make_field("Piola-Kirchhoff-1", *this->fields)}, + projection{std::move(projection_)} { // resize all global fields (strain, stress, etc) this->fields->initialise(this->subdomain_resolutions, this->subdomain_locations); } /** * turns out that the default move container in combination with * clang segfaults under certain (unclear) cicumstances, because the * move constructor of the optional appears to be busted in gcc * 7.2. Copying it (K) instead of moving it fixes the issue, and * since it is a reference, the cost is practically nil */ template - CellBase::CellBase(CellBase && other): - subdomain_resolutions{std::move(other.subdomain_resolutions)}, - subdomain_locations{std::move(other.subdomain_locations)}, - domain_resolutions{std::move(other.domain_resolutions)}, - pixels{std::move(other.pixels)}, - domain_lengths{std::move(other.domain_lengths)}, - fields{std::move(other.fields)}, - F{other.F}, - P{other.P}, - K{other.K}, // this seems to segfault under clang if it's not a move - materials{std::move(other.materials)}, - projection{std::move(other.projection)} - { } + CellBase::CellBase(CellBase && other) + : subdomain_resolutions{std::move(other.subdomain_resolutions)}, + subdomain_locations{std::move(other.subdomain_locations)}, + domain_resolutions{std::move(other.domain_resolutions)}, + pixels{std::move(other.pixels)}, domain_lengths{std::move( + other.domain_lengths)}, + fields{std::move(other.fields)}, F{other.F}, P{other.P}, + K{other.K}, // this seems to segfault under clang if it's not a move + materials{std::move(other.materials)}, projection{std::move( + other.projection)} {} /* ---------------------------------------------------------------------- */ template typename CellBase::Material_t & CellBase::add_material(Material_ptr mat) { this->materials.push_back(std::move(mat)); return *this->materials.back(); } - /* ---------------------------------------------------------------------- */ template auto CellBase::get_strain_vector() -> Vector_ref { return this->get_strain().eigenvec(); } /* ---------------------------------------------------------------------- */ template auto CellBase::get_stress_vector() const -> ConstVector_ref { return this->get_stress().eigenvec(); } /* ---------------------------------------------------------------------- */ template - void CellBase:: - set_uniform_strain(const Eigen::Ref & strain) { + void CellBase::set_uniform_strain( + const Eigen::Ref & strain) { this->F.get_map() = strain; } /* ---------------------------------------------------------------------- */ template auto CellBase::evaluate_stress() -> ConstVector_ref { if (not this->initialised) { this->initialise(); } for (auto & mat : this->materials) { mat->compute_stresses(this->F, this->P, this->get_formulation()); } return this->P.const_eigenvec(); } /* ---------------------------------------------------------------------- */ template - auto CellBase:: - evaluate_stress_tangent() -> std::array { + auto CellBase::evaluate_stress_tangent() + -> std::array { if (not this->initialised) { this->initialise(); } constexpr bool create_tangent{true}; this->get_tangent(create_tangent); for (auto & mat : this->materials) { mat->compute_stresses_tangent(this->F, this->P, this->K.value(), this->get_formulation()); } const TangentField_t & k = this->K.value(); - return std::array{ - this->P.const_eigenvec(), k.const_eigenvec()}; + return std::array{this->P.const_eigenvec(), + k.const_eigenvec()}; } /* ---------------------------------------------------------------------- */ template - auto CellBase:: - evaluate_projected_directional_stiffness - (Eigen::Ref delF) -> Vector_ref { + auto CellBase::evaluate_projected_directional_stiffness( + Eigen::Ref delF) -> Vector_ref { // the following const_cast should be safe, as long as the // constructed delF_field is const itself - const TypedField delF_field - ("Proxied raw memory for strain increment", - *this->fields, - Eigen::Map(const_cast(delF.data()), delF.size()), - this->F.get_nb_components()); + const TypedField delF_field( + "Proxied raw memory for strain increment", *this->fields, + Eigen::Map(const_cast(delF.data()), delF.size()), + this->F.get_nb_components()); if (!this->K) { - throw std::runtime_error - ("currently only implemented for cases where a stiffness matrix " - "exists"); + throw std::runtime_error( + "currently only implemented for cases where a stiffness matrix " + "exists"); } if (delF.size() != this->get_nb_dof()) { std::stringstream err{}; err << "input should be of size ndof = ¶(" << this->subdomain_resolutions - << ") × " << DimS << "² = "<< this->get_nb_dof() << " but I got " + << ") × " << DimS << "² = " << this->get_nb_dof() << " but I got " << delF.size(); throw std::runtime_error(err.str()); } const std::string out_name{"δP; temp output for directional stiffness"}; auto & delP = this->get_managed_T2_field(out_name); auto Kmap{this->K.value().get().get_map()}; auto delPmap{delP.get_map()}; - MatrixFieldMap - delFmap(delF_field); + MatrixFieldMap delFmap( + delF_field); - for (auto && tup: - akantu::zip(Kmap, delFmap, delPmap)) { + for (auto && tup : akantu::zip(Kmap, delFmap, delPmap)) { auto & k = std::get<0>(tup); auto & df = std::get<1>(tup); auto & dp = std::get<2>(tup); dp = Matrices::tensmult(k, df); } return Vector_ref(this->project(delP).data(), this->get_nb_dof()); } /* ---------------------------------------------------------------------- */ template std::array CellBase::get_strain_shape() const { return this->projection->get_strain_shape(); } /* ---------------------------------------------------------------------- */ template void CellBase::apply_projection(Eigen::Ref vec) { TypedField field("Proxy for projection", - *this->fields, - vec, + *this->fields, vec, this->F.get_nb_components()); this->projection->apply_projection(field); } /* ---------------------------------------------------------------------- */ template typename CellBase::FullResponse_t CellBase::evaluate_stress_tangent(StrainField_t & grad) { if (this->initialised == false) { this->initialise(); } //! High level compatibility checks if (grad.size() != this->F.size()) { throw std::runtime_error("Size mismatch"); } constexpr bool create_tangent{true}; this->get_tangent(create_tangent); for (auto & mat : this->materials) { mat->compute_stresses_tangent(grad, this->P, this->K.value(), this->get_formulation()); } return std::tie(this->P, this->K.value()); } /* ---------------------------------------------------------------------- */ template typename CellBase::StressField_t & - CellBase::directional_stiffness(const TangentField_t &K, - const StrainField_t &delF, - StressField_t &delP) { - for (auto && tup: - akantu::zip(K.get_map(), delF.get_map(), delP.get_map())) { + CellBase::directional_stiffness(const TangentField_t & K, + const StrainField_t & delF, + StressField_t & delP) { + for (auto && tup : + akantu::zip(K.get_map(), delF.get_map(), delP.get_map())) { auto & k = std::get<0>(tup); auto & df = std::get<1>(tup); auto & dp = std::get<2>(tup); dp = Matrices::tensmult(k, df); } return this->project(delP); } /* ---------------------------------------------------------------------- */ template typename CellBase::Vector_ref - CellBase:: - directional_stiffness_vec(const Eigen::Ref &delF) { + CellBase::directional_stiffness_vec( + const Eigen::Ref & delF) { if (!this->K) { - throw std::runtime_error - ("currently only implemented for cases where a stiffness matrix " - "exists"); + throw std::runtime_error( + "currently only implemented for cases where a stiffness matrix " + "exists"); } if (delF.size() != this->get_nb_dof()) { std::stringstream err{}; err << "input should be of size ndof = ¶(" << this->subdomain_resolutions - << ") × " << DimS << "² = "<< this->get_nb_dof() << " but I got " + << ") × " << DimS << "² = " << this->get_nb_dof() << " but I got " << delF.size(); throw std::runtime_error(err.str()); } const std::string out_name{"temp output for directional stiffness"}; const std::string in_name{"temp input for directional stiffness"}; auto & out_tempref = this->get_managed_T2_field(out_name); auto & in_tempref = this->get_managed_T2_field(in_name); Vector_ref(in_tempref.data(), this->get_nb_dof()) = delF; this->directional_stiffness(this->K.value(), in_tempref, out_tempref); return Vector_ref(out_tempref.data(), this->get_nb_dof()); } /* ---------------------------------------------------------------------- */ template - Eigen::ArrayXXd - CellBase:: - directional_stiffness_with_copy - (Eigen::Ref delF) { + Eigen::ArrayXXd CellBase::directional_stiffness_with_copy( + Eigen::Ref delF) { if (!this->K) { - throw std::runtime_error - ("currently only implemented for cases where a stiffness matrix " - "exists"); + throw std::runtime_error( + "currently only implemented for cases where a stiffness matrix " + "exists"); } const std::string out_name{"temp output for directional stiffness"}; const std::string in_name{"temp input for directional stiffness"}; auto & out_tempref = this->get_managed_T2_field(out_name); auto & in_tempref = this->get_managed_T2_field(in_name); in_tempref.eigen() = delF; this->directional_stiffness(this->K.value(), in_tempref, out_tempref); return out_tempref.eigen(); } /* ---------------------------------------------------------------------- */ template typename CellBase::StressField_t & - CellBase::project(StressField_t &field) { + CellBase::project(StressField_t & field) { this->projection->apply_projection(field); return field; } /* ---------------------------------------------------------------------- */ template typename CellBase::StrainField_t & CellBase::get_strain() { if (this->initialised == false) { this->initialise(); } return this->F; } /* ---------------------------------------------------------------------- */ template const typename CellBase::StressField_t & CellBase::get_stress() const { return this->P; } /* ---------------------------------------------------------------------- */ template const typename CellBase::TangentField_t & CellBase::get_tangent(bool create) { if (!this->K) { if (create) { this->K = - make_field("Tangent Stiffness", *this->fields); + make_field("Tangent Stiffness", *this->fields); } else { - throw std::runtime_error - ("K does not exist"); + throw std::runtime_error("K does not exist"); } } return this->K.value(); } /* ---------------------------------------------------------------------- */ template typename CellBase::StrainField_t & CellBase::get_managed_T2_field(std::string unique_name) { if (!this->fields->check_field_exists(unique_name)) { return make_field(unique_name, *this->fields); } else { - return static_cast(this->fields->at(unique_name)); + return static_cast(this->fields->at(unique_name)); } } /* ---------------------------------------------------------------------- */ template - auto - CellBase::get_managed_real_field(std::string unique_name, - size_t nb_components) -> - Field_t & { + auto CellBase::get_managed_real_field(std::string unique_name, + size_t nb_components) + -> Field_t & { if (!this->fields->check_field_exists(unique_name)) { return make_field>(unique_name, *this->fields, nb_components); } else { auto & ret_ref{Field_t::check_ref(this->fields->at(unique_name))}; if (ret_ref.get_nb_components() != nb_components) { std::stringstream err{}; err << "Field '" << unique_name << "' already exists and it has " << ret_ref.get_nb_components() << " components. You asked for a field " << "with " << nb_components << "components."; throw std::runtime_error(err.str()); } return ret_ref; } } /* ---------------------------------------------------------------------- */ template - auto CellBase:: - get_globalised_internal_real_field(const std::string & unique_name) - -> Field_t & { + auto CellBase::get_globalised_internal_real_field( + const std::string & unique_name) -> Field_t & { using LField_t = typename Field_t::LocalField_t; // start by checking that the field exists at least once, and that // it always has th same number of components std::set nb_component_categories{}; std::vector> local_fields; for (auto & mat : this->materials) { auto & coll = mat->get_collection(); if (coll.check_field_exists(unique_name)) { auto & field{LField_t::check_ref(coll[unique_name])}; local_fields.emplace_back(field); nb_component_categories.insert(field.get_nb_components()); } } if (nb_component_categories.size() != 1) { const auto & nb_match{nb_component_categories.size()}; std::stringstream err_str{}; if (nb_match > 1) { err_str << "The fields named '" << unique_name << "' do not have the " << "same number of components in every material, which is a " << "requirement for globalising them! The following values " << "were found by material:" << std::endl; for (auto & mat : this->materials) { auto & coll = mat->get_collection(); if (coll.check_field_exists(unique_name)) { auto & field{LField_t::check_ref(coll[unique_name])}; err_str << field.get_nb_components() << " components in material '" << mat->get_name() << "'" << std::endl; } } } else { err_str << "The field named '" << unique_name << "' does not exist in " << "any of the materials and can therefore not be globalised!"; } throw std::runtime_error(err_str.str()); } const Dim_t nb_components{*nb_component_categories.begin()}; // get and prepare the field auto & field{this->get_managed_real_field(unique_name, nb_components)}; field.set_zero(); // fill it with local internal values for (auto & local_field : local_fields) { field.fill_from_local(local_field); } return field; } /* ---------------------------------------------------------------------- */ template auto CellBase::get_managed_real_array(std::string unique_name, size_t nb_components) - -> Array_ref { + -> Array_ref { auto & field{this->get_managed_real_field(unique_name, nb_components)}; - return Array_ref - {field.data(), Dim_t(nb_components), Dim_t(field.size())}; + return Array_ref{field.data(), Dim_t(nb_components), + Dim_t(field.size())}; } /* ---------------------------------------------------------------------- */ template - auto CellBase:: - get_globalised_internal_real_array(const std::string & unique_name) - -> Array_ref { + auto CellBase::get_globalised_internal_real_array( + const std::string & unique_name) -> Array_ref { auto & field{this->get_globalised_internal_real_field(unique_name)}; - return Array_ref - {field.data(), Dim_t(field.get_nb_components()), Dim_t(field.size())}; + return Array_ref{field.data(), Dim_t(field.get_nb_components()), + Dim_t(field.size())}; } /* ---------------------------------------------------------------------- */ template void CellBase::initialise(FFT_PlanFlags flags) { // check that all pixels have been assigned exactly one material this->check_material_coverage(); for (auto && mat : this->materials) { mat->initialise(); } // initialise the projection and compute the fft plan this->projection->initialise(flags); this->initialised = true; } /* ---------------------------------------------------------------------- */ template void CellBase::save_history_variables() { for (auto && mat : this->materials) { mat->save_history_variables(); } } /* ---------------------------------------------------------------------- */ template - typename CellBase::iterator - CellBase::begin() { + typename CellBase::iterator CellBase::begin() { return this->pixels.begin(); } /* ---------------------------------------------------------------------- */ template - typename CellBase::iterator - CellBase::end() { + typename CellBase::iterator CellBase::end() { return this->pixels.end(); } /* ---------------------------------------------------------------------- */ template auto CellBase::get_adaptor() -> Adaptor { return Adaptor(*this); } /* ---------------------------------------------------------------------- */ template void CellBase::check_material_coverage() { auto nb_pixels = CcoordOps::get_size(this->subdomain_resolutions); - std::vector*> assignments(nb_pixels, nullptr); + std::vector *> assignments(nb_pixels, nullptr); for (auto & mat : this->materials) { for (auto & pixel : *mat) { auto index = CcoordOps::get_index(this->subdomain_resolutions, - this->subdomain_locations, - pixel); - auto& assignment{assignments.at(index)}; + this->subdomain_locations, pixel); + auto & assignment{assignments.at(index)}; if (assignment != nullptr) { std::stringstream err{}; err << "Pixel " << pixel << "is already assigned to material '" << assignment->get_name() << "' and cannot be reassigned to material '" << mat->get_name(); throw std::runtime_error(err.str()); } else { assignments[index] = mat.get(); } } } // find and identify unassigned pixels std::vector unassigned_pixels; for (size_t i = 0; i < assignments.size(); ++i) { if (assignments[i] == nullptr) { - unassigned_pixels.push_back( - CcoordOps::get_ccoord(this->subdomain_resolutions, - this->subdomain_locations, i)); + unassigned_pixels.push_back(CcoordOps::get_ccoord( + this->subdomain_resolutions, this->subdomain_locations, i)); } } if (unassigned_pixels.size() != 0) { - std::stringstream err {}; + std::stringstream err{}; err << "The following pixels have were not assigned a material: "; for (auto & pixel : unassigned_pixels) { err << pixel << ", "; } err << "and that cannot be handled"; throw std::runtime_error(err.str()); } } template class CellBase; template class CellBase; } // namespace muSpectre diff --git a/src/cell/cell_base.hh b/src/cell/cell_base.hh index 9cfed67..369a050 100644 --- a/src/cell/cell_base.hh +++ b/src/cell/cell_base.hh @@ -1,599 +1,596 @@ /** * @file cell_base.hh * * @author Till Junge * * @date 01 Nov 2017 * * @brief Base class representing a unit cell cell with single * projection operator * * Copyright © 2017 Till Junge * * µSpectre 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, 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 Lesser General Public License * along with µSpectre; see the file COPYING. If not, write to the * Free Software Foundation, Inc., 59 Temple Place - Suite 330, * * Boston, MA 02111-1307, USA. * * Additional permission under GNU GPL version 3 section 7 * * If you modify this Program, or any covered work, by linking or combining it * with proprietary FFT implementations or numerical libraries, containing parts * covered by the terms of those libraries' licenses, the licensors of this * Program grant you additional permission to convey the resulting work. */ #ifndef SRC_CELL_CELL_BASE_HH_ #define SRC_CELL_CELL_BASE_HH_ #include "common/common.hh" #include "common/ccoord_operations.hh" #include "common/field.hh" #include "common/utilities.hh" #include "materials/material_base.hh" #include "fft/projection_base.hh" #include "cell/cell_traits.hh" #include #include #include #include #include namespace muSpectre { /** * Cell adaptors implement the matrix-vector multiplication and * allow the system to be used like a sparse matrix in * conjugate-gradient-type solvers */ template class CellAdaptor; /** * Base class for cells that is not templated and therefore can be * in solvers that see cells as runtime-polymorphic objects. This * allows the use of standard * (i.e. spectral-method-implementation-agnostic) solvers, as for * instance the scipy solvers */ class Cell { public: //! sparse matrix emulation using Adaptor = CellAdaptor; //! dynamic vector type for interactions with numpy/scipy/solvers etc. using Vector_t = Eigen::Matrix; //! dynamic matrix type for setting strains using Matrix_t = Eigen::Matrix; //! dynamic generic array type for interaction with numpy, i/o, etc template using Array_t = Eigen::Array; //! ref to dynamic generic array template using Array_ref = Eigen::Map>; //! ref to constant vector using ConstVector_ref = Eigen::Map; //! output vector reference for solvers using Vector_ref = Eigen::Map; //! Default constructor Cell() = default; //! Copy constructor - Cell(const Cell &other) = default; + Cell(const Cell & other) = default; //! Move constructor - Cell(Cell &&other) = default; + Cell(Cell && other) = default; //! Destructor - virtual ~Cell() = default; + virtual ~Cell() = default; //! Copy assignment operator - Cell& operator=(const Cell &other) = default; + Cell & operator=(const Cell & other) = default; //! Move assignment operator - Cell& operator=(Cell &&other) = default; + Cell & operator=(Cell && other) = default; //! for handling double initialisations right - bool is_initialised() const {return this->initialised;} + bool is_initialised() const { return this->initialised; } //! returns the number of degrees of freedom in the cell virtual Dim_t get_nb_dof() const = 0; //! number of pixels in the cell virtual size_t size() const = 0; //! return the communicator object virtual const Communicator & get_communicator() const = 0; /** * formulation is hard set by the choice of the projection class */ virtual const Formulation & get_formulation() const = 0; /** * returns the material dimension of the problem */ virtual Dim_t get_material_dim() const = 0; /** * returns the number of rows and cols for the strain matrix type * (for full storage, the strain is stored in material_dim × * material_dim matrices, but in symmetriy storage, it is a column * vector) */ virtual std::array get_strain_shape() const = 0; /** * returns a writable map onto the strain field of this cell. This * corresponds to the unknowns in a typical solve cycle. */ virtual Vector_ref get_strain_vector() = 0; /** * returns a read-only map onto the stress field of this * cell. This corresponds to the intermediate (and finally, total) * solution in a typical solve cycle */ virtual ConstVector_ref get_stress_vector() const = 0; - /** * evaluates and returns the stress for the currently set strain */ virtual ConstVector_ref evaluate_stress() = 0; /** - * evaluates and returns the stress and stiffness for the currently set strain + * evaluates and returns the stress and stiffness for the currently set + * strain */ virtual std::array evaluate_stress_tangent() = 0; - /** * applies the projection operator in-place on the input vector */ virtual void apply_projection(Eigen::Ref vec) = 0; /** * freezes all the history variables of the materials */ virtual void save_history_variables() = 0; /** * evaluates the directional and projected stiffness (this * corresponds to G:K:δF in de Geus 2017, * http://dx.doi.org/10.1016/j.cma.2016.12.032). It seems that * this operation needs to be implemented with a copy in oder to * be compatible with scipy and EigenCG etc (At the very least, * the copy is only made once) */ - virtual Vector_ref evaluate_projected_directional_stiffness - (Eigen::Ref delF) = 0; - + virtual Vector_ref evaluate_projected_directional_stiffness( + Eigen::Ref delF) = 0; /** * returns a ref to a field named 'unique_name" of real values * managed by the cell. If the field does not yet exist, it is * created. * * @param unique_name name of the field. If the field already * exists, an array ref mapped onto it is returned. Else, a new * field with that name is created and returned- * * @param nb_components number of components to be stored *per * pixel*. For new fields any positive number can be chosen. When * accessing an existing field, this must correspond to the * existing field size, and a `std::runtime_error` is thrown if * this is not satisfied */ virtual Array_ref get_managed_real_array(std::string unique_name, size_t nb_components) = 0; /** * Convenience function to copy local (internal) fields of * materials into a global field. At least one of the materials in * the cell needs to contain an internal field named * `unique_name`. If multiple materials contain such a field, they * all need to be of same scalar type and same number of * components. This does not work for split pixel cells or * laminate pixel cells, as they can have multiple entries for the * same pixel. Pixels for which no field named `unique_name` * exists get an array of zeros. * * @param unique_name fieldname to fill the global field with. At * least one material must have such a field, or a * `std::runtime_error` is thrown */ virtual Array_ref get_globalised_internal_real_array(const std::string & unique_name) = 0; /** * set uniform strain (typically used to initialise problems */ virtual void set_uniform_strain(const Eigen::Ref &) = 0; //! get a sparse matrix view on the cell virtual Adaptor get_adaptor() = 0; protected: bool initialised{false}; //!< to handle double initialisation right private: }; //! DimS spatial dimension (dimension of problem //! DimM material_dimension (dimension of constitutive law) template - class CellBase: public Cell { + class CellBase : public Cell { public: using Parent = Cell; using Ccoord = Ccoord_t; //!< cell coordinates type using Rcoord = Rcoord_t; //!< physical coordinates type //! global field collection using FieldCollection_t = GlobalFieldCollection; //! the collection is handled in a `std::unique_ptr` using Collection_ptr = std::unique_ptr; //! polymorphic base material type using Material_t = MaterialBase; //! materials handled through `std::unique_ptr`s using Material_ptr = std::unique_ptr; //! polymorphic base projection type using Projection_t = ProjectionBase; //! projections handled through `std::unique_ptr`s using Projection_ptr = std::unique_ptr; //! dynamic global fields template using Field_t = TypedField; //! expected type for strain fields using StrainField_t = - TensorField; + TensorField; //! expected type for stress fields using StressField_t = - TensorField; + TensorField; //! expected type for tangent stiffness fields using TangentField_t = - TensorField; + TensorField; //! combined stress and tangent field using FullResponse_t = - std::tuple; + std::tuple; //! iterator type over all cell pixel's using iterator = typename CcoordOps::Pixels::iterator; //! dynamic vector type for interactions with numpy/scipy/solvers etc. using Vector_t = typename Parent::Vector_t; //! ref to constant vector using ConstVector_ref = typename Parent::ConstVector_ref; //! output vector reference for solvers using Vector_ref = typename Parent::Vector_ref; //! dynamic array type for interactions with numpy/scipy/solvers, etc. template using Array_t = typename Parent::Array_t; //! dynamic array type for interactions with numpy/scipy/solvers, etc. template using Array_ref = typename Parent::Array_ref; //! sparse matrix emulation using Adaptor = Parent::Adaptor; //! Default constructor CellBase() = delete; //! constructor using sizes and resolution explicit CellBase(Projection_ptr projection); //! Copy constructor - CellBase(const CellBase &other) = delete; + CellBase(const CellBase & other) = delete; //! Move constructor - CellBase(CellBase &&other); + CellBase(CellBase && other); //! Destructor virtual ~CellBase() = default; //! Copy assignment operator - CellBase& operator=(const CellBase &other) = delete; + CellBase & operator=(const CellBase & other) = delete; //! Move assignment operator - CellBase& operator=(CellBase &&other) = default; + CellBase & operator=(CellBase && other) = default; /** * Materials can only be moved. This is to assure exclusive * ownership of any material by this cell */ Material_t & add_material(Material_ptr mat); - /** * returns a writable map onto the strain field of this cell. This * corresponds to the unknowns in a typical solve cycle. */ Vector_ref get_strain_vector() override; /** * returns a read-only map onto the stress field of this * cell. This corresponds to the intermediate (and finally, total) * solution in a typical solve cycle */ ConstVector_ref get_stress_vector() const override; /** * evaluates and returns the stress for the currently set strain */ ConstVector_ref evaluate_stress() override; /** - * evaluates and returns the stress and stiffness for the currently set strain + * evaluates and returns the stress and stiffness for the currently set + * strain */ std::array evaluate_stress_tangent() override; - /** * evaluates the directional and projected stiffness (this * corresponds to G:K:δF in de Geus 2017, * http://dx.doi.org/10.1016/j.cma.2016.12.032). It seems that * this operation needs to be implemented with a copy in oder to * be compatible with scipy and EigenCG etc. (At the very least, * the copy is only made once) */ - Vector_ref evaluate_projected_directional_stiffness - (Eigen::Ref delF) override; + Vector_ref evaluate_projected_directional_stiffness( + Eigen::Ref delF) override; //! return the template param DimM (required for polymorphic use of `Cell` - Dim_t get_material_dim() const final {return DimM;} + Dim_t get_material_dim() const final { return DimM; } /** * returns the number of rows and cols for the strain matrix type * (for full storage, the strain is stored in material_dim × * material_dim matrices, but in symmetriy storage, it is a column * vector) */ std::array get_strain_shape() const final; /** * applies the projection operator in-place on the input vector */ void apply_projection(Eigen::Ref vec) final; - - /** * set uniform strain (typically used to initialise problems */ void set_uniform_strain(const Eigen::Ref &) override; - /** * evaluates all materials */ FullResponse_t evaluate_stress_tangent(StrainField_t & F); /** * evaluate directional stiffness (i.e. G:K:δF or G:K:δε) */ StressField_t & directional_stiffness(const TangentField_t & K, const StrainField_t & delF, StressField_t & delP); /** * vectorized version for eigen solvers, no copy, but only works * when fields have ArrayStore=false */ Vector_ref directional_stiffness_vec(const Eigen::Ref & delF); /** * Evaluate directional stiffness into a temporary array and * return a copy. This is a costly and wasteful interface to * directional_stiffness and should only be used for debugging or * in the python interface */ - Eigen::ArrayXXd directional_stiffness_with_copy - (Eigen::Ref delF); + Eigen::ArrayXXd + directional_stiffness_with_copy(Eigen::Ref delF); /** * Convenience function circumventing the neeed to use the * underlying projection */ StressField_t & project(StressField_t & field); //! returns a ref to the cell's strain field StrainField_t & get_strain(); //! returns a ref to the cell's stress field const StressField_t & get_stress() const; //! returns a ref to the cell's tangent stiffness field const TangentField_t & get_tangent(bool create = false); //! returns a ref to a temporary field managed by the cell StrainField_t & get_managed_T2_field(std::string unique_name); //! returns a ref to a temporary field of real values managed by the cell Field_t & get_managed_real_field(std::string unique_name, size_t nb_components); /** * returns a Array ref to a temporary field of real values managed by the * cell */ - Array_ref - get_managed_real_array(std::string unique_name, - size_t nb_components) final; + Array_ref get_managed_real_array(std::string unique_name, + size_t nb_components) final; /** * returns a global field filled from local (internal) fields of * the materials. see `Cell::get_globalised_internal_array` for * details. */ Field_t & get_globalised_internal_real_field(const std::string & unique_name); //! see `Cell::get_globalised_internal_array` for details Array_ref get_globalised_internal_real_array(const std::string & unique_name) final; /** * general initialisation; initialises the projection and * fft_engine (i.e. infrastructure) but not the materials. These * need to be initialised separately */ void initialise(FFT_PlanFlags flags = FFT_PlanFlags::estimate); /** * for materials with state variables, these typically need to be * saved/updated an the end of each load increment, this function * calls this update for each material in the cell */ void save_history_variables() final; iterator begin(); //!< iterator to the first pixel - iterator end(); //!< iterator past the last pixel + iterator end(); //!< iterator past the last pixel //! number of pixels in the cell - size_t size() const final {return pixels.size();} + size_t size() const final { return pixels.size(); } //! return the subdomain resolutions of the cell const Ccoord & get_subdomain_resolutions() const { - return this->subdomain_resolutions;} + return this->subdomain_resolutions; + } //! return the subdomain locations of the cell const Ccoord & get_subdomain_locations() const { - return this->subdomain_locations;} + return this->subdomain_locations; + } //! return the domain resolutions of the cell const Ccoord & get_domain_resolutions() const { - return this->domain_resolutions;} + return this->domain_resolutions; + } //! return the sizes of the cell - const Rcoord & get_domain_lengths() const {return this->domain_lengths;} + const Rcoord & get_domain_lengths() const { return this->domain_lengths; } /** * formulation is hard set by the choice of the projection class */ const Formulation & get_formulation() const final { - return this->projection->get_formulation();} + return this->projection->get_formulation(); + } /** * get a reference to the projection object. should only be * required for debugging */ Eigen::Map get_projection() { - return this->projection->get_operator();} + return this->projection->get_operator(); + } //! returns the spatial size - constexpr static Dim_t get_sdim() {return DimS;} + constexpr static Dim_t get_sdim() { return DimS; } //! return a sparse matrix adaptor to the cell Adaptor get_adaptor() override; //! returns the number of degrees of freedom in the cell - Dim_t get_nb_dof() const override {return this->size()*ipow(DimS, 2);}; + Dim_t get_nb_dof() const override { return this->size() * ipow(DimS, 2); }; //! return the communicator object const Communicator & get_communicator() const override { return this->projection->get_communicator(); } protected: //! make sure that every pixel is assigned to one and only one material void check_material_coverage(); const Ccoord & subdomain_resolutions; //!< the cell's subdomain resolutions - const Ccoord & subdomain_locations; //!< the cell's subdomain resolutions - const Ccoord & domain_resolutions; //!< the cell's domain resolutions + const Ccoord & subdomain_locations; //!< the cell's subdomain resolutions + const Ccoord & domain_resolutions; //!< the cell's domain resolutions CcoordOps::Pixels pixels; //!< helper to iterate over the pixels - const Rcoord & domain_lengths; //!< the cell's lengths + const Rcoord & domain_lengths; //!< the cell's lengths Collection_ptr fields; //!< handle for the global fields of the cell - StrainField_t & F; //!< ref to strain field - StressField_t & P; //!< ref to stress field + StrainField_t & F; //!< ref to strain field + StressField_t & P; //!< ref to stress field //! Tangent field might not even be required; so this is an //! optional ref_wrapper instead of a ref optional> K{}; //! container of the materials present in the cell std::vector materials{}; Projection_ptr projection; //!< handle for the projection operator private: }; - /** * lightweight resource handle wrapping a `muSpectre::Cell` or * a subclass thereof into `Eigen::EigenBase`, so it can be * interpreted as a sparse matrix by Eigen solvers */ template - class CellAdaptor: public Eigen::EigenBase> { + class CellAdaptor : public Eigen::EigenBase> { public: using Scalar = double; //!< sparse matrix traits using RealScalar = double; //!< sparse matrix traits using StorageIndex = int; //!< sparse matrix traits enum { ColsAtCompileTime = Eigen::Dynamic, MaxColsAtCompileTime = Eigen::Dynamic, RowsAtCompileTime = Eigen::Dynamic, MaxRowsAtCompileTime = Eigen::Dynamic, IsRowMajor = false }; //! constructor - explicit CellAdaptor(Cell & cell): cell{cell} {} + explicit CellAdaptor(Cell & cell) : cell{cell} {} //! returns the number of logical rows - Eigen::Index rows() const {return this->cell.get_nb_dof();} + Eigen::Index rows() const { return this->cell.get_nb_dof(); } //! returns the number of logical columns - Eigen::Index cols() const {return this->rows();} + Eigen::Index cols() const { return this->rows(); } //! implementation of the evaluation - template + template Eigen::Product - operator*(const Eigen::MatrixBase& x) const { - return Eigen::Product - (*this, x.derived()); + operator*(const Eigen::MatrixBase & x) const { + return Eigen::Product( + *this, x.derived()); } Cell & cell; //!< ref to the cell }; } // namespace muSpectre - namespace Eigen { namespace internal { //! Implementation of `muSpectre::CellAdaptor` * `Eigen::DenseVector` //! through a specialization of `Eigen::internal::generic_product_impl`: - template // GEMV stands for matrix-vector - struct generic_product_impl - : generic_product_impl_base > { + template // GEMV stands for matrix-vector + struct generic_product_impl + : generic_product_impl_base> { //! undocumented typedef typename Product::Scalar Scalar; //! undocumented - template - static void scaleAndAddTo(Dest& dst, const CellAdaptor& lhs, - const Rhs& rhs, const Scalar& /*alpha*/) { + template + static void scaleAndAddTo(Dest & dst, const CellAdaptor & lhs, + const Rhs & rhs, const Scalar & /*alpha*/) { // This method should implement "dst += alpha * lhs * rhs" inplace, // however, for iterative solvers, alpha is always equal to 1, so // let's not bother about it. // Here we could simply call dst.noalias() += lhs.my_matrix() * rhs, - dst.noalias() += const_cast(lhs).cell. - evaluate_projected_directional_stiffness(rhs); + dst.noalias() += + const_cast(lhs) + .cell.evaluate_projected_directional_stiffness(rhs); } }; } // namespace internal } // namespace Eigen #endif // SRC_CELL_CELL_BASE_HH_ diff --git a/src/cell/cell_factory.hh b/src/cell/cell_factory.hh index 4dd9fe4..a9efbf3 100644 --- a/src/cell/cell_factory.hh +++ b/src/cell/cell_factory.hh @@ -1,164 +1,147 @@ /** * @file cell_factory.hh * * @author Till Junge * * @date 15 Dec 2017 * * @brief Cell factories to help create cells with ease * * Copyright © 2017 Till Junge * * µSpectre 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, 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 Lesser General Public License * along with µSpectre; see the file COPYING. If not, write to the * Free Software Foundation, Inc., 59 Temple Place - Suite 330, * * Boston, MA 02111-1307, USA. * * Additional permission under GNU GPL version 3 section 7 * * If you modify this Program, or any covered work, by linking or combining it * with proprietary FFT implementations or numerical libraries, containing parts * covered by the terms of those libraries' licenses, the licensors of this * Program grant you additional permission to convey the resulting work. */ #ifndef SRC_CELL_CELL_FACTORY_HH_ #define SRC_CELL_CELL_FACTORY_HH_ #include "common/common.hh" #include "common/ccoord_operations.hh" #include "cell/cell_base.hh" #include "fft/projection_finite_strain_fast.hh" #include "fft/projection_small_strain.hh" #include "fft/fftw_engine.hh" #ifdef WITH_MPI #include "common/communicator.hh" #include "fft/fftwmpi_engine.hh" #endif #include namespace muSpectre { - /** * Create a unique ptr to a Projection operator (with appropriate * FFT_engine) to be used in a cell constructor */ - template > - inline - std::unique_ptr> - cell_input(Ccoord_t resolutions, - Rcoord_t lengths, - Formulation form) { - auto fft_ptr{ - std::make_unique(resolutions, - dof_for_formulation(form, DimS))}; + template > + inline std::unique_ptr> + cell_input(Ccoord_t resolutions, Rcoord_t lengths, + Formulation form) { + auto fft_ptr{std::make_unique(resolutions, + dof_for_formulation(form, DimS))}; switch (form) { - case Formulation::finite_strain: { - using Projection = ProjectionFiniteStrainFast; - return std::make_unique(std::move(fft_ptr), lengths); - break; - } - case Formulation::small_strain: { - using Projection = ProjectionSmallStrain; - return std::make_unique(std::move(fft_ptr), lengths); - break; - } - default: { - throw std::runtime_error("unknow formulation"); - break; - } + case Formulation::finite_strain: { + using Projection = ProjectionFiniteStrainFast; + return std::make_unique(std::move(fft_ptr), lengths); + break; + } + case Formulation::small_strain: { + using Projection = ProjectionSmallStrain; + return std::make_unique(std::move(fft_ptr), lengths); + break; + } + default: { + throw std::runtime_error("unknow formulation"); + break; + } } } - /** * convenience function to create a cell (avoids having to build * and move the chain of unique_ptrs */ template , typename FFTEngine = FFTWEngine> - inline - Cell make_cell(Ccoord_t resolutions, - Rcoord_t lengths, - Formulation form) { - auto && input = cell_input(resolutions, lengths, - form); + inline Cell make_cell(Ccoord_t resolutions, Rcoord_t lengths, + Formulation form) { + auto && input = + cell_input(resolutions, lengths, form); auto cell{Cell{std::move(input)}}; return cell; } #ifdef WITH_MPI /** * Create a unique ptr to a parallel Projection operator (with appropriate * FFT_engine) to be used in a cell constructor */ - template > - inline - std::unique_ptr> - parallel_cell_input(Ccoord_t resolutions, - Rcoord_t lengths, - Formulation form, - const Communicator & comm) { - auto fft_ptr{std::make_unique(resolutions, - dof_for_formulation(form, DimM), - comm)}; + template > + inline std::unique_ptr> + parallel_cell_input(Ccoord_t resolutions, Rcoord_t lengths, + Formulation form, const Communicator & comm) { + auto fft_ptr{std::make_unique( + resolutions, dof_for_formulation(form, DimM), comm)}; switch (form) { - case Formulation::finite_strain: { - using Projection = ProjectionFiniteStrainFast; - return std::make_unique(std::move(fft_ptr), lengths); - break; - } - case Formulation::small_strain: { - using Projection = ProjectionSmallStrain; - return std::make_unique(std::move(fft_ptr), lengths); - break; - } - default: { - throw std::runtime_error("unknown formulation"); - break; - } + case Formulation::finite_strain: { + using Projection = ProjectionFiniteStrainFast; + return std::make_unique(std::move(fft_ptr), lengths); + break; + } + case Formulation::small_strain: { + using Projection = ProjectionSmallStrain; + return std::make_unique(std::move(fft_ptr), lengths); + break; + } + default: { + throw std::runtime_error("unknown formulation"); + break; + } } } - /** * convenience function to create a parallel cell (avoids having to build * and move the chain of unique_ptrs */ template , - typename FFTEngine = FFTWMPIEngine> - inline - Cell make_parallel_cell(Ccoord_t resolutions, - Rcoord_t lengths, - Formulation form, - const Communicator & comm) { - auto && input = parallel_cell_input(resolutions, - lengths, - form, comm); + typename Cell = CellBase, + typename FFTEngine = FFTWMPIEngine> + inline Cell make_parallel_cell(Ccoord_t resolutions, + Rcoord_t lengths, Formulation form, + const Communicator & comm) { + auto && input = parallel_cell_input( + resolutions, lengths, form, comm); auto cell{Cell{std::move(input)}}; return cell; } #endif /* WITH_MPI */ } // namespace muSpectre #endif // SRC_CELL_CELL_FACTORY_HH_ diff --git a/src/cell/cell_traits.hh b/src/cell/cell_traits.hh index b044eee..7437fae 100644 --- a/src/cell/cell_traits.hh +++ b/src/cell/cell_traits.hh @@ -1,61 +1,59 @@ /** * @file cell_traits.hh * * @author Till Junge * * @date 19 Jan 2018 * * @brief Provides traits for Eigen solvers to be able to use Cells * * Copyright © 2018 Till Junge * * µSpectre 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, 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 Lesser General Public License * along with µSpectre; see the file COPYING. If not, write to the * Free Software Foundation, Inc., 59 Temple Place - Suite 330, * * Boston, MA 02111-1307, USA. * * Additional permission under GNU GPL version 3 section 7 * * If you modify this Program, or any covered work, by linking or combining it * with proprietary FFT implementations or numerical libraries, containing parts * covered by the terms of those libraries' licenses, the licensors of this * Program grant you additional permission to convey the resulting work. */ #include "common/common.hh" #include #ifndef SRC_CELL_CELL_TRAITS_HH_ #define SRC_CELL_CELL_TRAITS_HH_ namespace muSpectre { template class CellAdaptor; } // namespace muSpectre namespace Eigen { namespace internal { using Dim_t = muSpectre::Dim_t; //!< universal index type - using Real = muSpectre::Real; //!< universal real value type - template - struct traits> : - public Eigen::internal::traits > - {}; + using Real = muSpectre::Real; //!< universal real value type + template + struct traits> + : public Eigen::internal::traits> {}; } // namespace internal } // namespace Eigen - #endif // SRC_CELL_CELL_TRAITS_HH_ diff --git a/src/common/T4_map_proxy.hh b/src/common/T4_map_proxy.hh index 3b3c2bf..b9c378c 100644 --- a/src/common/T4_map_proxy.hh +++ b/src/common/T4_map_proxy.hh @@ -1,111 +1,106 @@ /** * @file T4_map_proxy.hh * * @author Till Junge * * @date 19 Nov 2017 * * @brief Map type to allow fourth-order tensor-like maps on 2D matrices * * Copyright © 2017 Till Junge * * µSpectre 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, 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 Lesser General Public License * along with µSpectre; see the file COPYING. If not, write to the * Free Software Foundation, Inc., 59 Temple Place - Suite 330, * * Boston, MA 02111-1307, USA. * * Additional permission under GNU GPL version 3 section 7 * * If you modify this Program, or any covered work, by linking or combining it * with proprietary FFT implementations or numerical libraries, containing parts * covered by the terms of those libraries' licenses, the licensors of this * Program grant you additional permission to convey the resulting work. */ #ifndef SRC_COMMON_T4_MAP_PROXY_HH_ #define SRC_COMMON_T4_MAP_PROXY_HH_ #include "common/eigen_tools.hh" #include #include #include namespace muSpectre { /** * simple adapter function to create a matrix that can be mapped as a tensor */ template - using T4Mat = Eigen::Matrix; + using T4Mat = Eigen::Matrix; /** * Map onto `muSpectre::T4Mat` */ template - using T4MatMap = std::conditional_t>, + using T4MatMap = std::conditional_t>, Eigen::Map>>; - - template - struct DimCounter{}; + template + struct DimCounter {}; template struct DimCounter> { private: using Type = Eigen::MatrixBase; constexpr static Dim_t Rows{Type::RowsAtCompileTime}; + public: - static_assert(Rows != Eigen::Dynamic, - "matrix type not statically sized"); - static_assert(Rows == Type::ColsAtCompileTime, - "matrix type not square"); + static_assert(Rows != Eigen::Dynamic, "matrix type not statically sized"); + static_assert(Rows == Type::ColsAtCompileTime, "matrix type not square"); constexpr static Dim_t value{ct_sqrt(Rows)}; - static_assert(value*value == Rows, + static_assert(value * value == Rows, "Only integer numbers of dimensions allowed"); }; /** * provides index-based access to fourth-order Tensors represented * by square matrices */ template - inline auto get(const Eigen::MatrixBase& t4, - Dim_t i, Dim_t j, Dim_t k, Dim_t l) - -> decltype(auto) { + inline auto get(const Eigen::MatrixBase & t4, Dim_t i, Dim_t j, Dim_t k, + Dim_t l) -> decltype(auto) { constexpr Dim_t Dim{DimCounter>::value}; - const auto myColStride{ - (t4.colStride() == 1) ? t4.colStride(): t4.colStride()/Dim}; - const auto myRowStride{ - (t4.rowStride() == 1) ? t4.rowStride(): t4.rowStride()/Dim}; + const auto myColStride{(t4.colStride() == 1) ? t4.colStride() + : t4.colStride() / Dim}; + const auto myRowStride{(t4.rowStride() == 1) ? t4.rowStride() + : t4.rowStride() / Dim}; return t4(i * myRowStride + j * myColStride, k * myRowStride + l * myColStride); } template - inline auto get(Eigen::MatrixBase& t4, Dim_t i, Dim_t j, Dim_t k, Dim_t l) - -> decltype(t4.coeffRef(i, j)) { + inline auto get(Eigen::MatrixBase & t4, Dim_t i, Dim_t j, Dim_t k, + Dim_t l) -> decltype(t4.coeffRef(i, j)) { constexpr Dim_t Dim{DimCounter>::value}; - const auto myColStride{ - (t4.colStride() == 1) ? t4.colStride(): t4.colStride()/Dim}; - const auto myRowStride{ - (t4.rowStride() == 1) ? t4.rowStride(): t4.rowStride()/Dim}; + const auto myColStride{(t4.colStride() == 1) ? t4.colStride() + : t4.colStride() / Dim}; + const auto myRowStride{(t4.rowStride() == 1) ? t4.rowStride() + : t4.rowStride() / Dim}; return t4.coeffRef(i * myRowStride + j * myColStride, k * myRowStride + l * myColStride); } - } // namespace muSpectre #endif // SRC_COMMON_T4_MAP_PROXY_HH_ diff --git a/src/common/ccoord_operations.hh b/src/common/ccoord_operations.hh index 2084854..231b549 100644 --- a/src/common/ccoord_operations.hh +++ b/src/common/ccoord_operations.hh @@ -1,323 +1,333 @@ /** * @file ccoord_operations.hh * * @author Till Junge * * @date 29 Sep 2017 * * @brief common operations on pixel addressing * * Copyright © 2017 Till Junge * * µSpectre 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, 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 Lesser General Public License * along with µSpectre; see the file COPYING. If not, write to the * Free Software Foundation, Inc., 59 Temple Place - Suite 330, * * Boston, MA 02111-1307, USA. * * Additional permission under GNU GPL version 3 section 7 * * If you modify this Program, or any covered work, by linking or combining it * with proprietary FFT implementations or numerical libraries, containing parts * covered by the terms of those libraries' licenses, the licensors of this * Program grant you additional permission to convey the resulting work. */ #include #include #include #include #include #include "common/common.hh" #include "common/iterators.hh" #ifndef SRC_COMMON_CCOORD_OPERATIONS_HH_ #define SRC_COMMON_CCOORD_OPERATIONS_HH_ namespace muSpectre { -namespace CcoordOps { - -namespace internal { -//! simple helper returning the first argument and ignoring the second -template constexpr T ret(T val, size_t /*dummy*/) { return val; } - -//! helper to build cubes -template -constexpr std::array cube_fun(T val, std::index_sequence) { - return std::array{ret(val, I)...}; -} - -//! computes hermitian size according to FFTW -template -constexpr Ccoord_t herm(const Ccoord_t &full_sizes, - std::index_sequence) { - return Ccoord_t{full_sizes[I]..., full_sizes.back() / 2 + 1}; -} - -//! compute the stride in a direction of a row-major grid -template -constexpr Dim_t stride(const Ccoord_t &sizes, const size_t index) { - static_assert(Dim > 0, "only for positive numbers of dimensions"); - - auto const diff{Dim - 1 - Dim_t(index)}; - Dim_t ret_val{1}; - for (Dim_t i{0}; i < diff; ++i) { - ret_val *= sizes[Dim - 1 - i]; - } - return ret_val; -} - -//! get all strides from a row-major grid (helper function) -template -constexpr Ccoord_t compute_strides(const Ccoord_t &sizes, - std::index_sequence) { - return Ccoord_t{stride(sizes, I)...}; -} -} // namespace internal - -//-----------------------------------------------------------------------// -//! returns a grid of equal resolutions in each direction -template -constexpr std::array get_cube(T size) { - return internal::cube_fun(size, std::make_index_sequence{}); -} - -/* ---------------------------------------------------------------------- */ -//! returns the hermition grid to correcsponding to a full grid -template -constexpr Ccoord_t get_hermitian_sizes(Ccoord_t full_sizes) { - return internal::herm(full_sizes, std::make_index_sequence{}); -} - -//! return physical vector of a cell of cubic pixels -template -Eigen::Matrix get_vector(const Ccoord_t &ccoord, - Real pix_size = 1.) { - Eigen::Matrix retval; - for (size_t i = 0; i < dim; ++i) { - retval[i] = pix_size * ccoord[i]; - } - return retval; -} - -/* ---------------------------------------------------------------------- */ -//! return physical vector of a cell of general pixels -template -Eigen::Matrix get_vector(const Ccoord_t &ccoord, - Eigen::Matrix pix_size) { - Eigen::Matrix retval = pix_size; - for (size_t i = 0; i < dim; ++i) { - retval[i] *= ccoord[i]; - } - return retval; -} - -/* ---------------------------------------------------------------------- */ -//! return physical vector of a cell of general pixels -template -Eigen::Matrix get_vector(const Ccoord_t &ccoord, - const std::array &pix_size) { - Eigen::Matrix retval{}; - for (size_t i = 0; i < dim; ++i) { - retval[i] = pix_size[i] * ccoord[i]; - } - return retval; -} - -/* ---------------------------------------------------------------------- */ -//! get all strides from a row-major grid -template -constexpr Ccoord_t get_default_strides(const Ccoord_t &sizes) { - return internal::compute_strides(sizes, std::make_index_sequence{}); -} - -//----------------------------------------------------------------------------// -//! get the i-th pixel in a grid of size sizes -template -constexpr Ccoord_t get_ccoord(const Ccoord_t &resolutions, - const Ccoord_t &locations, - Dim_t index) { - Ccoord_t retval{{0}}; - Dim_t factor{1}; - for (Dim_t i = dim - 1; i >= 0; --i) { - retval[i] = index / factor % resolutions[i] + locations[i]; - if (i != 0) { - factor *= resolutions[i]; - } - } - return retval; -} - -//----------------------------------------------------------------------------// -//! get the i-th pixel in a grid of size sizes -template -constexpr Ccoord_t get_ccoord(const Ccoord_t &resolutions, - const Ccoord_t &locations, Dim_t index, + namespace CcoordOps { + + namespace internal { + //! simple helper returning the first argument and ignoring the second + template + constexpr T ret(T val, size_t /*dummy*/) { + return val; + } + + //! helper to build cubes + template + constexpr std::array cube_fun(T val, std::index_sequence) { + return std::array{ret(val, I)...}; + } + + //! computes hermitian size according to FFTW + template + constexpr Ccoord_t herm(const Ccoord_t & full_sizes, std::index_sequence) { - Ccoord_t ccoord{get_ccoord(resolutions, locations, index)}; - return Ccoord_t({ccoord[I]...}); -} - -//-----------------------------------------------------------------------// -//! get the linear index of a pixel in a given grid -template -constexpr Dim_t get_index(const Ccoord_t &sizes, - const Ccoord_t &locations, - const Ccoord_t &ccoord) { - Dim_t retval{0}; - Dim_t factor{1}; - for (Dim_t i = dim - 1; i >= 0; --i) { - retval += (ccoord[i] - locations[i]) * factor; - if (i != 0) { - factor *= sizes[i]; + return Ccoord_t{full_sizes[I]..., full_sizes.back() / 2 + 1}; + } + + //! compute the stride in a direction of a row-major grid + template + constexpr Dim_t stride(const Ccoord_t & sizes, const size_t index) { + static_assert(Dim > 0, "only for positive numbers of dimensions"); + + auto const diff{Dim - 1 - Dim_t(index)}; + Dim_t ret_val{1}; + for (Dim_t i{0}; i < diff; ++i) { + ret_val *= sizes[Dim - 1 - i]; + } + return ret_val; + } + + //! get all strides from a row-major grid (helper function) + template + constexpr Ccoord_t compute_strides(const Ccoord_t & sizes, + std::index_sequence) { + return Ccoord_t{stride(sizes, I)...}; + } + } // namespace internal + + //-----------------------------------------------------------------------// + //! returns a grid of equal resolutions in each direction + template + constexpr std::array get_cube(T size) { + return internal::cube_fun(size, std::make_index_sequence{}); } - } - return retval; -} - -//-----------------------------------------------------------------------// -//! get the linear index of a pixel given a set of strides -template -constexpr Dim_t get_index_from_strides(const Ccoord_t &strides, - const Ccoord_t &ccoord) { - Dim_t retval{0}; - for (const auto &tup : akantu::zip(strides, ccoord)) { - const auto &stride = std::get<0>(tup); - const auto &ccord_ = std::get<1>(tup); - retval += stride * ccord_; - } - return retval; -} - -//-----------------------------------------------------------------------// -//! get the number of pixels in a grid -template constexpr size_t get_size(const Ccoord_t &sizes) { - Dim_t retval{1}; - for (size_t i = 0; i < dim; ++i) { - retval *= sizes[i]; - } - return retval; -} - -//-----------------------------------------------------------------------// -//! get the number of pixels in a grid given its strides -template -constexpr size_t get_size_from_strides(const Ccoord_t &sizes, - const Ccoord_t &strides) { - return sizes[0] * strides[0]; -} - -/* ---------------------------------------------------------------------- */ -/** - * centralises iterating over square (or cubic) discretisation - * grids. The optional parameter pack `dmap` can be used to - * specify the order of the axes in which to iterate over the - * dimensions (i.e., dmap = 0, 1, 2 is rowmajor, and 0, 2, 1 would - * be a custom order in which the second and third dimension are - * transposed - */ -template class Pixels { - public: - //! constructor - Pixels(const Ccoord_t &resolutions = Ccoord_t{}, - const Ccoord_t &locations = Ccoord_t{}) - : resolutions{resolutions}, locations{locations} {}; - //! copy constructor - Pixels(const Pixels &other) = default; - //! assignment operator - Pixels &operator=(const Pixels &other) = default; - virtual ~Pixels() = default; - - /** - * iterators over `Pixels` dereferences to cell coordinates - */ - class iterator { - public: - using value_type = Ccoord_t; //!< stl conformance - using const_value_type = const value_type; //!< stl conformance - using pointer = value_type *; //!< stl conformance - using difference_type = std::ptrdiff_t; //!< stl conformance - using iterator_category = std::forward_iterator_tag; //!< stl - //!< conformance - using reference = value_type; //!< stl conformance - - //! constructor - explicit iterator(const Pixels &pixels, bool begin = true); - virtual ~iterator() = default; - //! dereferencing - inline value_type operator*() const; - //! pre-increment - inline iterator &operator++(); - //! inequality - inline bool operator!=(const iterator &other) const; - //! equality - inline bool operator==(const iterator &other) const; - - protected: - const Pixels &pixels; //!< ref to pixels in cell - size_t index; //!< index of currect pointed-to pixel - }; - //! stl conformance - inline iterator begin() const { return iterator(*this); } - //! stl conformance - inline iterator end() const { return iterator(*this, false); } - //! stl conformance - inline size_t size() const { return get_size(this->resolutions); } - - protected: - Ccoord_t resolutions; //!< resolutions of this domain - Ccoord_t locations; //!< locations of this domain -}; - -/* ---------------------------------------------------------------------- */ -template -Pixels::iterator::iterator(const Pixels &pixels, bool begin) - : pixels{pixels}, index{begin ? 0 : get_size(pixels.resolutions)} {} - -/* ---------------------------------------------------------------------- */ -template -typename Pixels::iterator::value_type - Pixels::iterator::operator*() const { - return get_ccoord( - pixels.resolutions, pixels.locations, this->index, - std::conditional_t, - std::index_sequence>{}); -} - -/* ---------------------------------------------------------------------- */ -template -bool Pixels::iterator::operator!=(const iterator &other) const { - return (this->index != other.index) || (&this->pixels != &other.pixels); -} - -/* ---------------------------------------------------------------------- */ -template -bool Pixels::iterator::operator==(const iterator &other) const { - return !(*this != other); -} - -/* ---------------------------------------------------------------------- */ -template -typename Pixels::iterator &Pixels::iterator:: -operator++() { - ++this->index; - return *this; -} - -} // namespace CcoordOps + + /* ---------------------------------------------------------------------- */ + //! returns the hermition grid to correcsponding to a full grid + template + constexpr Ccoord_t get_hermitian_sizes(Ccoord_t full_sizes) { + return internal::herm(full_sizes, + std::make_index_sequence{}); + } + + //! return physical vector of a cell of cubic pixels + template + Eigen::Matrix get_vector(const Ccoord_t & ccoord, + Real pix_size = 1.) { + Eigen::Matrix retval; + for (size_t i = 0; i < dim; ++i) { + retval[i] = pix_size * ccoord[i]; + } + return retval; + } + + /* ---------------------------------------------------------------------- */ + //! return physical vector of a cell of general pixels + template + Eigen::Matrix + get_vector(const Ccoord_t & ccoord, + Eigen::Matrix pix_size) { + Eigen::Matrix retval = pix_size; + for (size_t i = 0; i < dim; ++i) { + retval[i] *= ccoord[i]; + } + return retval; + } + + /* ---------------------------------------------------------------------- */ + //! return physical vector of a cell of general pixels + template + Eigen::Matrix get_vector(const Ccoord_t & ccoord, + const std::array & pix_size) { + Eigen::Matrix retval{}; + for (size_t i = 0; i < dim; ++i) { + retval[i] = pix_size[i] * ccoord[i]; + } + return retval; + } + + /* ---------------------------------------------------------------------- */ + //! get all strides from a row-major grid + template + constexpr Ccoord_t get_default_strides(const Ccoord_t & sizes) { + return internal::compute_strides(sizes, + std::make_index_sequence{}); + } + + //----------------------------------------------------------------------------// + //! get the i-th pixel in a grid of size sizes + template + constexpr Ccoord_t get_ccoord(const Ccoord_t & resolutions, + const Ccoord_t & locations, + Dim_t index) { + Ccoord_t retval{{0}}; + Dim_t factor{1}; + for (Dim_t i = dim - 1; i >= 0; --i) { + retval[i] = index / factor % resolutions[i] + locations[i]; + if (i != 0) { + factor *= resolutions[i]; + } + } + return retval; + } + + //----------------------------------------------------------------------------// + //! get the i-th pixel in a grid of size sizes + template + constexpr Ccoord_t get_ccoord(const Ccoord_t & resolutions, + const Ccoord_t & locations, + Dim_t index, std::index_sequence) { + Ccoord_t ccoord{get_ccoord(resolutions, locations, index)}; + return Ccoord_t({ccoord[I]...}); + } + + //-----------------------------------------------------------------------// + //! get the linear index of a pixel in a given grid + template + constexpr Dim_t get_index(const Ccoord_t & sizes, + const Ccoord_t & locations, + const Ccoord_t & ccoord) { + Dim_t retval{0}; + Dim_t factor{1}; + for (Dim_t i = dim - 1; i >= 0; --i) { + retval += (ccoord[i] - locations[i]) * factor; + if (i != 0) { + factor *= sizes[i]; + } + } + return retval; + } + + //-----------------------------------------------------------------------// + //! get the linear index of a pixel given a set of strides + template + constexpr Dim_t get_index_from_strides(const Ccoord_t & strides, + const Ccoord_t & ccoord) { + Dim_t retval{0}; + for (const auto & tup : akantu::zip(strides, ccoord)) { + const auto & stride = std::get<0>(tup); + const auto & ccord_ = std::get<1>(tup); + retval += stride * ccord_; + } + return retval; + } + + //-----------------------------------------------------------------------// + //! get the number of pixels in a grid + template + constexpr size_t get_size(const Ccoord_t & sizes) { + Dim_t retval{1}; + for (size_t i = 0; i < dim; ++i) { + retval *= sizes[i]; + } + return retval; + } + + //-----------------------------------------------------------------------// + //! get the number of pixels in a grid given its strides + template + constexpr size_t get_size_from_strides(const Ccoord_t & sizes, + const Ccoord_t & strides) { + return sizes[0] * strides[0]; + } + + /* ---------------------------------------------------------------------- */ + /** + * centralises iterating over square (or cubic) discretisation + * grids. The optional parameter pack `dmap` can be used to + * specify the order of the axes in which to iterate over the + * dimensions (i.e., dmap = 0, 1, 2 is rowmajor, and 0, 2, 1 would + * be a custom order in which the second and third dimension are + * transposed + */ + template + class Pixels { + public: + //! constructor + Pixels(const Ccoord_t & resolutions = Ccoord_t{}, + const Ccoord_t & locations = Ccoord_t{}) + : resolutions{resolutions}, locations{locations} {}; + //! copy constructor + Pixels(const Pixels & other) = default; + //! assignment operator + Pixels & operator=(const Pixels & other) = default; + virtual ~Pixels() = default; + + /** + * iterators over `Pixels` dereferences to cell coordinates + */ + class iterator { + public: + using value_type = Ccoord_t; //!< stl conformance + using const_value_type = const value_type; //!< stl conformance + using pointer = value_type *; //!< stl conformance + using difference_type = std::ptrdiff_t; //!< stl conformance + using iterator_category = std::forward_iterator_tag; //!< stl + //!< conformance + using reference = value_type; //!< stl conformance + + //! constructor + explicit iterator(const Pixels & pixels, bool begin = true); + virtual ~iterator() = default; + //! dereferencing + inline value_type operator*() const; + //! pre-increment + inline iterator & operator++(); + //! inequality + inline bool operator!=(const iterator & other) const; + //! equality + inline bool operator==(const iterator & other) const; + + protected: + const Pixels & pixels; //!< ref to pixels in cell + size_t index; //!< index of currect pointed-to pixel + }; + //! stl conformance + inline iterator begin() const { return iterator(*this); } + //! stl conformance + inline iterator end() const { return iterator(*this, false); } + //! stl conformance + inline size_t size() const { return get_size(this->resolutions); } + + protected: + Ccoord_t resolutions; //!< resolutions of this domain + Ccoord_t locations; //!< locations of this domain + }; + + /* ---------------------------------------------------------------------- */ + template + Pixels::iterator::iterator(const Pixels & pixels, bool begin) + : pixels{pixels}, index{begin ? 0 : get_size(pixels.resolutions)} {} + + /* ---------------------------------------------------------------------- */ + template + typename Pixels::iterator::value_type + Pixels::iterator::operator*() const { + return get_ccoord(pixels.resolutions, pixels.locations, this->index, + std::conditional_t, + std::index_sequence>{}); + } + + /* ---------------------------------------------------------------------- */ + template + bool Pixels::iterator:: + operator!=(const iterator & other) const { + return (this->index != other.index) || (&this->pixels != &other.pixels); + } + + /* ---------------------------------------------------------------------- */ + template + bool Pixels::iterator:: + operator==(const iterator & other) const { + return !(*this != other); + } + + /* ---------------------------------------------------------------------- */ + template + typename Pixels::iterator & Pixels::iterator:: + operator++() { + ++this->index; + return *this; + } + + } // namespace CcoordOps } // namespace muSpectre #endif // SRC_COMMON_CCOORD_OPERATIONS_HH_ diff --git a/src/common/common.cc b/src/common/common.cc index 5c1ddfd..062d3a8 100644 --- a/src/common/common.cc +++ b/src/common/common.cc @@ -1,104 +1,146 @@ /** * @file common.cc * * @author Till Junge * * @date 15 Nov 2017 * * @brief Implementation for common functions * * Copyright © 2017 Till Junge * * µSpectre 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, 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 Lesser General Public License * along with µSpectre; see the file COPYING. If not, write to the * Free Software Foundation, Inc., 59 Temple Place - Suite 330, * * Boston, MA 02111-1307, USA. * * Additional permission under GNU GPL version 3 section 7 * * If you modify this Program, or any covered work, by linking or combining it * with proprietary FFT implementations or numerical libraries, containing parts * covered by the terms of those libraries' licenses, the licensors of this * Program grant you additional permission to convey the resulting work. */ #include "common/common.hh" #include namespace muSpectre { /* ---------------------------------------------------------------------- */ std::ostream & operator<<(std::ostream & os, Formulation f) { switch (f) { - case Formulation::small_strain: {os << "small_strain"; break;} - case Formulation::finite_strain: {os << "finite_strain"; break;} + case Formulation::small_strain: { + os << "small_strain"; + break; + } + case Formulation::finite_strain: { + os << "finite_strain"; + break; + } default: - throw std::runtime_error - ("unknown formulation."); + throw std::runtime_error("unknown formulation."); break; } return os; } /* ---------------------------------------------------------------------- */ std::ostream & operator<<(std::ostream & os, StressMeasure s) { switch (s) { - case StressMeasure::Cauchy: {os << "Cauchy"; break;} - case StressMeasure::PK1: {os << "PK1"; break;} - case StressMeasure::PK2: {os << "PK2"; break;} - case StressMeasure::Kirchhoff: {os << "Kirchhoff"; break;} - case StressMeasure::Biot: {os << "Biot"; break;} - case StressMeasure::Mandel: {os << "Mandel"; break;} + case StressMeasure::Cauchy: { + os << "Cauchy"; + break; + } + case StressMeasure::PK1: { + os << "PK1"; + break; + } + case StressMeasure::PK2: { + os << "PK2"; + break; + } + case StressMeasure::Kirchhoff: { + os << "Kirchhoff"; + break; + } + case StressMeasure::Biot: { + os << "Biot"; + break; + } + case StressMeasure::Mandel: { + os << "Mandel"; + break; + } default: - throw std::runtime_error - ("a stress measure must be missing"); + throw std::runtime_error("a stress measure must be missing"); break; } return os; } /* ---------------------------------------------------------------------- */ std::ostream & operator<<(std::ostream & os, StrainMeasure s) { switch (s) { - case StrainMeasure::Gradient: {os << "Gradient"; break;} - case StrainMeasure::Infinitesimal: {os << "Infinitesimal"; break;} - case StrainMeasure::GreenLagrange: {os << "Green-Lagrange"; break;} - case StrainMeasure::Biot: {os << "Biot"; break;} - case StrainMeasure::Log: {os << "Logarithmic"; break;} - case StrainMeasure::Almansi: {os << "Almansi"; break;} - case StrainMeasure::RCauchyGreen: {os << "Right Cauchy-Green"; break;} - case StrainMeasure::LCauchyGreen: {os << "Left Cauchy-Green"; break;} + case StrainMeasure::Gradient: { + os << "Gradient"; + break; + } + case StrainMeasure::Infinitesimal: { + os << "Infinitesimal"; + break; + } + case StrainMeasure::GreenLagrange: { + os << "Green-Lagrange"; + break; + } + case StrainMeasure::Biot: { + os << "Biot"; + break; + } + case StrainMeasure::Log: { + os << "Logarithmic"; + break; + } + case StrainMeasure::Almansi: { + os << "Almansi"; + break; + } + case StrainMeasure::RCauchyGreen: { + os << "Right Cauchy-Green"; + break; + } + case StrainMeasure::LCauchyGreen: { + os << "Left Cauchy-Green"; + break; + } default: - throw std::runtime_error - ("a strain measure must be missing"); + throw std::runtime_error("a strain measure must be missing"); } return os; } /* ---------------------------------------------------------------------- */ void banner(std::string name, Uint year, std::string cpy_holder) { - std::cout - << std::endl - << "µSpectre "<< name << std::endl - << "Copyright © " << year << " " << cpy_holder - << std::endl - << "This program comes with ABSOLUTELY NO WARRANTY." - << std::endl - << "This is free software, and you are welcome to redistribute it" - << std::endl - << "under certain conditions, see the license file." - << std::endl << std::endl; + std::cout << std::endl + << "µSpectre " << name << std::endl + << "Copyright © " << year << " " << cpy_holder << std::endl + << "This program comes with ABSOLUTELY NO WARRANTY." << std::endl + << "This is free software, and you are welcome to redistribute it" + << std::endl + << "under certain conditions, see the license file." << std::endl + << std::endl; } } // namespace muSpectre diff --git a/src/common/common.hh b/src/common/common.hh index 31219b6..c99bcbd 100644 --- a/src/common/common.hh +++ b/src/common/common.hh @@ -1,310 +1,315 @@ /** * @file common.hh * * @author Till Junge * * @date 01 May 2017 * * @brief Small definitions of commonly used types throughout µSpectre * * @section LICENSE * * Copyright © 2017 Till Junge * * µSpectre 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, 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 Lesser General Public License * along with µSpectre; see the file COPYING. If not, write to the * Free Software Foundation, Inc., 59 Temple Place - Suite 330, * * Boston, MA 02111-1307, USA. * * Additional permission under GNU GPL version 3 section 7 * * If you modify this Program, or any covered work, by linking or combining it * with proprietary FFT implementations or numerical libraries, containing parts * covered by the terms of those libraries' licenses, the licensors of this * Program grant you additional permission to convey the resulting work. */ #include #include #include #include #include #include #ifndef SRC_COMMON_COMMON_HH_ #define SRC_COMMON_COMMON_HH_ namespace muSpectre { /** * Eigen uses signed integers for dimensions. For consistency, µSpectre uses them througout the code. needs to represent -1 for eigen */ using Dim_t = int; constexpr Dim_t oneD{1}; //!< constant for a one-dimensional problem constexpr Dim_t twoD{2}; //!< constant for a two-dimensional problem constexpr Dim_t threeD{3}; //!< constant for a three-dimensional problem constexpr Dim_t firstOrder{1}; //!< constant for vectors constexpr Dim_t secondOrder{2}; //!< constant second-order tensors constexpr Dim_t fourthOrder{4}; //!< constant fourth-order tensors //@{ //! @anchor scalars //! Scalar types used for mathematical calculations using Uint = unsigned int; using Int = int; using Real = double; using Complex = std::complex; //@} //! Ccoord_t are cell coordinates, i.e. integer coordinates - template using Ccoord_t = std::array; + template + using Ccoord_t = std::array; //! Real space coordinates - template using Rcoord_t = std::array; + template + using Rcoord_t = std::array; /** * Allows inserting `muSpectre::Ccoord_t` and `muSpectre::Rcoord_t` * into `std::ostream`s */ template - std::ostream &operator<<(std::ostream &os, const std::array &index) { + std::ostream & operator<<(std::ostream & os, + const std::array & index) { os << "("; for (size_t i = 0; i < dim - 1; ++i) { os << index[i] << ", "; } os << index.back() << ")"; return os; } //! element-wise division template - Rcoord_t operator/(const Rcoord_t &a, const Rcoord_t &b) { + Rcoord_t operator/(const Rcoord_t & a, const Rcoord_t & b) { Rcoord_t retval{a}; for (size_t i = 0; i < dim; ++i) { retval[i] /= b[i]; } return retval; } //! element-wise division template - Rcoord_t operator/(const Rcoord_t &a, const Ccoord_t &b) { + Rcoord_t operator/(const Rcoord_t & a, const Ccoord_t & b) { Rcoord_t retval{a}; for (size_t i = 0; i < dim; ++i) { retval[i] /= b[i]; } return retval; } //! convenience definitions constexpr Real pi{3.1415926535897932384626433}; //! compile-time potentiation required for field-size computations - template constexpr R ipow(R base, I exponent) { + template + constexpr R ipow(R base, I exponent) { static_assert(std::is_integral::value, "Type must be integer"); R retval{1}; for (I i = 0; i < exponent; ++i) { retval *= base; } return retval; } /** * Copyright banner to be printed to the terminal by executables * Arguments are the executable's name, year of writing and the name * + address of the copyright holder */ void banner(std::string name, Uint year, std::string cpy_holder); /** * Planner flags for FFT (follows FFTW, hopefully this choice will * be compatible with alternative FFT implementations) * @enum muSpectre::FFT_PlanFlags */ enum class FFT_PlanFlags { estimate, //!< cheapest plan for slowest execution measure, //!< more expensive plan for fast execution patient //!< very expensive plan for fastest execution }; //! continuum mechanics flags enum class Formulation { finite_strain, //!< causes evaluation in PK1(F) small_strain, //!< causes evaluation in σ(ε) small_strain_sym //!< symmetric storage as vector ε }; /** * compile time computation of voigt vector */ - template constexpr Dim_t vsize(Dim_t dim) { + template + constexpr Dim_t vsize(Dim_t dim) { if (sym) { return (dim * (dim - 1) / 2 + dim); } else { return dim * dim; } } //! compute the number of degrees of freedom to store for the strain //! tenor given dimension dim constexpr Dim_t dof_for_formulation(const Formulation form, const Dim_t dim) { switch (form) { case Formulation::small_strain_sym: { return vsize(dim); break; } default: return ipow(dim, 2); break; } } //! inserts `muSpectre::Formulation`s into `std::ostream`s - std::ostream &operator<<(std::ostream &os, Formulation f); + std::ostream & operator<<(std::ostream & os, Formulation f); /* ---------------------------------------------------------------------- */ //! Material laws can declare which type of stress measure they provide, //! and µSpectre will handle conversions enum class StressMeasure { Cauchy, //!< Cauchy stress σ PK1, //!< First Piola-Kirchhoff stress PK2, //!< Second Piola-Kirchhoff stress Kirchhoff, //!< Kirchhoff stress τ Biot, //!< Biot stress Mandel, //!< Mandel stress no_stress_ //!< only for triggering static_asserts }; //! inserts `muSpectre::StressMeasure`s into `std::ostream`s - std::ostream &operator<<(std::ostream &os, StressMeasure s); + std::ostream & operator<<(std::ostream & os, StressMeasure s); /* ---------------------------------------------------------------------- */ //! Material laws can declare which type of strain measure they require and //! µSpectre will provide it enum class StrainMeasure { Gradient, //!< placement gradient (δy/δx) Infinitesimal, //!< small strain tensor .5(∇u + ∇uᵀ) GreenLagrange, //!< Green-Lagrange strain .5(Fᵀ·F - I) Biot, //!< Biot strain Log, //!< logarithmic strain Almansi, //!< Almansi strain RCauchyGreen, //!< Right Cauchy-Green tensor LCauchyGreen, //!< Left Cauchy-Green tensor no_strain_ //!< only for triggering static_assert }; //! inserts `muSpectre::StrainMeasure`s into `std::ostream`s - std::ostream &operator<<(std::ostream &os, StrainMeasure s); + std::ostream & operator<<(std::ostream & os, StrainMeasure s); /* ---------------------------------------------------------------------- */ /** * all isotropic elastic moduli to identify conversions, such as E * = µ(3λ + 2µ)/(λ+µ). For the full description, see * https://en.wikipedia.org/wiki/Lam%C3%A9_parameters * Not all the conversions are implemented, so please add as needed */ enum class ElasticModulus { Bulk, //!< Bulk modulus K K = Bulk, //!< alias for ``ElasticModulus::Bulk`` Young, //!< Young's modulus E E = Young, //!< alias for ``ElasticModulus::Young`` lambda, //!< Lamé's first parameter λ Shear, //!< Shear modulus G or µ G = Shear, //!< alias for ``ElasticModulus::Shear`` mu = Shear, //!< alias for ``ElasticModulus::Shear`` Poisson, //!< Poisson's ratio ν nu = Poisson, //!< alias for ``ElasticModulus::Poisson`` Pwave, //!< P-wave modulus M M = Pwave, //!< alias for ``ElasticModulus::Pwave`` no_modulus_ }; //!< only for triggering static_asserts /** * define comparison in order to exploit that moduli can be * expressed in terms of any two other moduli in any order (e.g. K * = K(E, ν) = K(ν, E) */ constexpr inline bool operator<(ElasticModulus A, ElasticModulus B) { return static_cast(A) < static_cast(B); } /* ---------------------------------------------------------------------- */ /** Compile-time function to g strain measure stored by muSpectre depending on the formulation **/ constexpr StrainMeasure get_stored_strain_type(Formulation form) { switch (form) { case Formulation::finite_strain: { return StrainMeasure::Gradient; break; } case Formulation::small_strain: { return StrainMeasure::Infinitesimal; break; } default: return StrainMeasure::no_strain_; break; } } /** Compile-time function to g stress measure stored by muSpectre depending on the formulation **/ constexpr StressMeasure get_stored_stress_type(Formulation form) { switch (form) { case Formulation::finite_strain: { return StressMeasure::PK1; break; } case Formulation::small_strain: { return StressMeasure::Cauchy; break; } default: return StressMeasure::no_stress_; break; } } /* ---------------------------------------------------------------------- */ /** Compile-time functions to get the stress and strain measures after they may have been modified by choosing a formulation. For instance, a law that expecs a Green-Lagrange strain as input will get the infinitesimal strain tensor instead in a small strain computation **/ constexpr StrainMeasure get_formulation_strain_type(Formulation form, StrainMeasure expected) { switch (form) { case Formulation::finite_strain: { return expected; break; } case Formulation::small_strain: { return get_stored_strain_type(form); break; } default: return StrainMeasure::no_strain_; break; } } } // namespace muSpectre #ifndef EXPLICITLY_TURNED_ON_CXX17 #include "common/utilities.hh" #endif #endif // SRC_COMMON_COMMON_HH_ diff --git a/src/common/communicator.hh b/src/common/communicator.hh index 5cf7616..ca8ccdf 100644 --- a/src/common/communicator.hh +++ b/src/common/communicator.hh @@ -1,130 +1,155 @@ /** * @file communicator.hh * * @author Lars Pastewka * * @date 07 Mar 2018 * * @brief abstraction layer for the distributed memory communicator object * * Copyright © 2017 Till Junge * * µSpectre 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, 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 Lesser General Public License * along with µSpectre; see the file COPYING. If not, write to the * Free Software Foundation, Inc., 59 Temple Place - Suite 330, * * Boston, MA 02111-1307, USA. * * Additional permission under GNU GPL version 3 section 7 * * If you modify this Program, or any covered work, by linking or combining it * with proprietary FFT implementations or numerical libraries, containing parts * covered by the terms of those libraries' licenses, the licensors of this * Program grant you additional permission to convey the resulting work. */ #ifndef SRC_COMMON_COMMUNICATOR_HH_ #define SRC_COMMON_COMMUNICATOR_HH_ #ifdef WITH_MPI #include #endif namespace muSpectre { #ifdef WITH_MPI - template decltype(auto) mpi_type() {} - template <> inline decltype(auto) mpi_type() { return MPI_CHAR; } - template <> inline decltype(auto) - mpi_type() { return MPI_SHORT; } // NOLINT - template <> inline decltype(auto) mpi_type() { return MPI_INT; } - template <> inline decltype(auto) - mpi_type() { return MPI_LONG; } // NOLINT - template <> inline decltype(auto) mpi_type() { + template + decltype(auto) mpi_type() {} + template <> + inline decltype(auto) mpi_type() { + return MPI_CHAR; + } + template <> + inline decltype(auto) mpi_type() { // NOLINT + return MPI_SHORT; + } + template <> + inline decltype(auto) mpi_type() { + return MPI_INT; + } + template <> + inline decltype(auto) mpi_type() { // NOLINT + return MPI_LONG; + } + template <> + inline decltype(auto) mpi_type() { return MPI_UNSIGNED_CHAR; } - template <> inline decltype(auto) mpi_type() { // NOLINT + template <> + inline decltype(auto) mpi_type() { // NOLINT return MPI_UNSIGNED_SHORT; } - template <> inline decltype(auto) mpi_type() { + template <> + inline decltype(auto) mpi_type() { return MPI_UNSIGNED; } - template <> inline decltype(auto) mpi_type() { // NOLINT + template <> + inline decltype(auto) mpi_type() { // NOLINT return MPI_UNSIGNED_LONG; } - template <> inline decltype(auto) mpi_type() { return MPI_FLOAT; } - template <> inline decltype(auto) mpi_type() { return MPI_DOUBLE; } + template <> + inline decltype(auto) mpi_type() { + return MPI_FLOAT; + } + template <> + inline decltype(auto) mpi_type() { + return MPI_DOUBLE; + } //! lightweight abstraction for the MPI communicator object class Communicator { public: using MPI_Comm_ref = std::remove_pointer_t &; explicit Communicator(MPI_Comm comm = MPI_COMM_NULL) : comm{*comm} {}; ~Communicator() {} //! get rank of present process int rank() const { if (&comm == MPI_COMM_NULL) return 0; int res; MPI_Comm_rank(&this->comm, &res); return res; } //! get total number of processes int size() const { if (&comm == MPI_COMM_NULL) return 1; int res; MPI_Comm_size(&this->comm, &res); return res; } //! sum reduction on scalar types - template T sum(const T &arg) const { + template + T sum(const T & arg) const { if (&comm == MPI_COMM_NULL) return arg; T res; MPI_Allreduce(&arg, &res, 1, mpi_type(), MPI_SUM, &this->comm); return res; } MPI_Comm get_mpi_comm() { return &this->comm; } private: MPI_Comm_ref comm; }; #else /* WITH_MPI */ //! stub communicator object that doesn't communicate anything class Communicator { public: Communicator() {} ~Communicator() {} //! get rank of present process int rank() const { return 0; } //! get total number of processes int size() const { return 1; } //! sum reduction on scalar types - template T sum(const T &arg) const { return arg; } + template + T sum(const T & arg) const { + return arg; + } }; #endif } // namespace muSpectre #endif // SRC_COMMON_COMMUNICATOR_HH_ diff --git a/src/common/eigen_tools.hh b/src/common/eigen_tools.hh index 1879ac6..d72cc4a 100644 --- a/src/common/eigen_tools.hh +++ b/src/common/eigen_tools.hh @@ -1,334 +1,350 @@ /** * @file eigen_tools.hh * * @author Till Junge * * @date 20 Sep 2017 * * @brief small tools to be used with Eigen * * Copyright © 2017 Till Junge * * µSpectre 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, 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 Lesser General Public License * along with µSpectre; see the file COPYING. If not, write to the * Free Software Foundation, Inc., 59 Temple Place - Suite 330, * * Boston, MA 02111-1307, USA. * * Additional permission under GNU GPL version 3 section 7 * * If you modify this Program, or any covered work, by linking or combining it * with proprietary FFT implementations or numerical libraries, containing parts * covered by the terms of those libraries' licenses, the licensors of this * Program grant you additional permission to convey the resulting work. */ #ifndef SRC_COMMON_EIGEN_TOOLS_HH_ #define SRC_COMMON_EIGEN_TOOLS_HH_ #include "common/common.hh" #include #include #include #include namespace muSpectre { /* ---------------------------------------------------------------------- */ namespace internal { //! Creates a Eigen::Sizes type for a Tensor defined by an order and dim - template struct SizesByOrderHelper { + template + struct SizesByOrderHelper { //! type to use using Sizes = typename SizesByOrderHelper::Sizes; }; //! Creates a Eigen::Sizes type for a Tensor defined by an order and dim template struct SizesByOrderHelper<0, dim, dims...> { //! type to use using Sizes = Eigen::Sizes; }; } // namespace internal //! Creates a Eigen::Sizes type for a Tensor defined by an order and dim - template struct SizesByOrder { + template + struct SizesByOrder { static_assert(order > 0, "works only for order greater than zero"); //! `Eigen::Sizes` using Sizes = typename internal::SizesByOrderHelper::Sizes; }; /* ---------------------------------------------------------------------- */ namespace internal { /* ---------------------------------------------------------------------- */ //! Call a passed lambda with the unpacked sizes as arguments template struct CallSizesHelper { //! applies the call - static decltype(auto) call(Fun_t &&fun) { + static decltype(auto) call(Fun_t && fun) { static_assert(order > 0, "can't handle empty sizes b)"); return CallSizesHelper::call(fun); } }; /* ---------------------------------------------------------------------- */ template //! Call a passed lambda with the unpacked sizes as arguments struct CallSizesHelper<0, Fun_t, dim, args...> { //! applies the call - static decltype(auto) call(Fun_t &&fun) { return fun(args...); } + static decltype(auto) call(Fun_t && fun) { return fun(args...); } }; } // namespace internal /** * takes a lambda and calls it with the proper `Eigen::Sizes` * unpacked as arguments. Is used to call constructors of a * `Eigen::Tensor` or map thereof in a context where the spatial * dimension is templated */ template - inline decltype(auto) call_sizes(Fun_t &&fun) { + inline decltype(auto) call_sizes(Fun_t && fun) { static_assert(order > 1, "can't handle empty sizes"); return internal::CallSizesHelper::call( std::forward(fun)); } // compile-time square root static constexpr Dim_t ct_sqrt(Dim_t res, Dim_t l, Dim_t r) { if (l == r) { return r; } else { const auto mid = (r + l) / 2; if (mid * mid >= res) { return ct_sqrt(res, l, mid); } else { return ct_sqrt(res, mid + 1, r); } } } static constexpr Dim_t ct_sqrt(Dim_t res) { return ct_sqrt(res, 1, res); } namespace EigenCheck { /** * Structure to determine whether an expression can be evaluated * into a `Eigen::Matrix`, `Eigen::Array`, etc. and which helps * determine compile-time size */ - template struct is_matrix { + template + struct is_matrix { //! raw type for testing using T = std::remove_reference_t; //! evaluated test constexpr static bool value{ std::is_same::XprKind, Eigen::MatrixXpr>::value}; }; /** * Helper class to check whether an `Eigen::Array` or * `Eigen::Matrix` is statically sized */ - template struct is_fixed { + template + struct is_fixed { //! raw type for testing using T = std::remove_reference_t; //! evaluated test constexpr static bool value{T::SizeAtCompileTime != Eigen::Dynamic}; }; /** * Helper class to check whether an `Eigen::Array` or `Eigen::Matrix` is a * static-size and square. */ - template struct is_square { + template + struct is_square { //! raw type for testing using T = std::remove_reference_t; //! true if the object is square and statically sized constexpr static bool value{ (T::RowsAtCompileTime == T::ColsAtCompileTime) && is_fixed::value}; }; /** * computes the dimension from a second order tensor represented * square matrix or array */ - template struct tensor_dim { + template + struct tensor_dim { //! raw type for testing using T = std::remove_reference_t; static_assert(is_matrix::value, "The type of t is not understood as an Eigen::Matrix"); static_assert(is_square::value, "t's matrix isn't square"); //! evaluated dimension constexpr static Dim_t value{T::RowsAtCompileTime}; }; //! computes the dimension from a fourth order tensor represented //! by a square matrix - template struct tensor_4_dim { + template + struct tensor_4_dim { //! raw type for testing using T = std::remove_reference_t; static_assert(is_matrix::value, "The type of t is not understood as an Eigen::Matrix"); static_assert(is_square::value, "t's matrix isn't square"); //! evaluated dimension constexpr static Dim_t value{ct_sqrt(T::RowsAtCompileTime)}; static_assert(value * value == T::RowsAtCompileTime, "This is not a fourth-order tensor mapped on a square " "matrix"); }; }; // namespace EigenCheck namespace log_comp { //! Matrix type used for logarithm evaluation - template using Mat_t = Eigen::Matrix; + template + using Mat_t = Eigen::Matrix; //! Vector type used for logarithm evaluation - template using Vec_t = Eigen::Matrix; + template + using Vec_t = Eigen::Matrix; //! This is a static implementation of the explicit determination //! of log(Tensor) following Jog, C.S. J Elasticity (2008) 93: //! 141. https://doi.org/10.1007/s10659-008-9169-x /* ---------------------------------------------------------------------- */ - template struct Proj { + template + struct Proj { //! wrapped function (raison d'être) - static inline decltype(auto) compute(const Vec_t &eigs, - const Mat_t &T) { + static inline decltype(auto) compute(const Vec_t & eigs, + const Mat_t & T) { static_assert(dim > 0, "only works for positive dimensions"); return 1. / (eigs(i) - eigs(j)) * (T - eigs(j) * Mat_t::Identity()) * Proj::compute(eigs, T); } }; //! catch the case when there's nothing to do - template struct Proj { + template + struct Proj { //! wrapped function (raison d'être) - static inline decltype(auto) compute(const Vec_t &eigs, - const Mat_t &T) { + static inline decltype(auto) compute(const Vec_t & eigs, + const Mat_t & T) { static_assert(dim > 0, "only works for positive dimensions"); return Proj::compute(eigs, T); } }; //! catch the normal tail case - template struct Proj { + template + struct Proj { static constexpr Dim_t j{0}; //!< short-hand //! wrapped function (raison d'être) - static inline decltype(auto) compute(const Vec_t &eigs, - const Mat_t &T) { + static inline decltype(auto) compute(const Vec_t & eigs, + const Mat_t & T) { static_assert(dim > 0, "only works for positive dimensions"); return 1. / (eigs(i) - eigs(j)) * (T - eigs(j) * Mat_t::Identity()); } }; //! catch the tail case when the last dimension is i - template struct Proj { + template + struct Proj { static constexpr Dim_t i{0}; //!< short-hand static constexpr Dim_t j{1}; //!< short-hand //! wrapped function (raison d'être) - static inline decltype(auto) compute(const Vec_t &eigs, - const Mat_t &T) { + static inline decltype(auto) compute(const Vec_t & eigs, + const Mat_t & T) { static_assert(dim > 0, "only works for positive dimensions"); return 1. / (eigs(i) - eigs(j)) * (T - eigs(j) * Mat_t::Identity()); } }; //! catch the general tail case - template <> struct Proj<1, 0, 0> { + template <> + struct Proj<1, 0, 0> { static constexpr Dim_t dim{1}; //!< short-hand static constexpr Dim_t i{0}; //!< short-hand static constexpr Dim_t j{0}; //!< short-hand //! wrapped function (raison d'être) static inline decltype(auto) compute(const Vec_t & /*eigs*/, const Mat_t & /*T*/) { return Mat_t::Identity(); } }; //! Product term template - inline decltype(auto) P(const Vec_t &eigs, const Mat_t &T) { + inline decltype(auto) P(const Vec_t & eigs, const Mat_t & T) { return Proj::compute(eigs, T); } //! sum term - template struct Summand { + template + struct Summand { //! wrapped function (raison d'être) - static inline decltype(auto) compute(const Vec_t &eigs, - const Mat_t &T) { + static inline decltype(auto) compute(const Vec_t & eigs, + const Mat_t & T) { return std::log(eigs(i)) * P(eigs, T) + Summand::compute(eigs, T); } }; //! sum term - template struct Summand { + template + struct Summand { static constexpr Dim_t i{0}; //!< short-hand //! wrapped function (raison d'être) - static inline decltype(auto) compute(const Vec_t &eigs, - const Mat_t &T) { + static inline decltype(auto) compute(const Vec_t & eigs, + const Mat_t & T) { return std::log(eigs(i)) * P(eigs, T); } }; //! sum implementation template - inline decltype(auto) Sum(const Vec_t &eigs, const Mat_t &T) { + inline decltype(auto) Sum(const Vec_t & eigs, const Mat_t & T) { return Summand::compute(eigs, T); } } // namespace log_comp /** * computes the matrix logarithm efficiently for dim=1, 2, or 3 for * a diagonizable tensor. For larger tensors, better use the direct * eigenvalue/vector computation */ template - inline decltype(auto) logm(const log_comp::Mat_t &mat) { + inline decltype(auto) logm(const log_comp::Mat_t & mat) { using Mat = log_comp::Mat_t; Eigen::SelfAdjointEigenSolver Solver{}; Solver.computeDirect(mat, Eigen::EigenvaluesOnly); return Mat{log_comp::Sum(Solver.eigenvalues(), mat)}; } /** * compute the matrix exponential. This may not be the most * efficient way to do this */ template - inline decltype(auto) expm(const log_comp::Mat_t &mat) { + inline decltype(auto) expm(const log_comp::Mat_t & mat) { using Mat = log_comp::Mat_t; Eigen::SelfAdjointEigenSolver Solver{}; Solver.computeDirect(mat, Eigen::ComputeEigenvectors); Mat retval{Mat::Zero()}; for (Dim_t i = 0; i < dim; ++i) { - const Real &val = Solver.eigenvalues()(i); - auto &vec = Solver.eigenvectors().col(i); + const Real & val = Solver.eigenvalues()(i); + auto & vec = Solver.eigenvectors().col(i); retval += std::exp(val) * vec * vec.transpose(); } return retval; } } // namespace muSpectre #endif // SRC_COMMON_EIGEN_TOOLS_HH_ diff --git a/src/common/field.hh b/src/common/field.hh index ebae0ba..f8d35b4 100644 --- a/src/common/field.hh +++ b/src/common/field.hh @@ -1,667 +1,668 @@ /** * @file field.hh * * @author Till Junge * * @date 07 Sep 2017 * * @brief header-only implementation of a field for field collections * * Copyright © 2017 Till Junge * * µSpectre 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, 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 Lesser General Public License * along with µSpectre; see the file COPYING. If not, write to the * Free Software Foundation, Inc., 59 Temple Place - Suite 330, * * Boston, MA 02111-1307, USA. * * Additional permission under GNU GPL version 3 section 7 * * If you modify this Program, or any covered work, by linking or combining it * with proprietary FFT implementations or numerical libraries, containing parts * covered by the terms of those libraries' licenses, the licensors of this * Program grant you additional permission to convey the resulting work. */ #ifndef SRC_COMMON_FIELD_HH_ #define SRC_COMMON_FIELD_HH_ #include "common/T4_map_proxy.hh" #include "common/field_typed.hh" #include #include #include #include #include #include #include #include #include namespace muSpectre { namespace internal { /* ---------------------------------------------------------------------- */ //! declaraton for friending template class FieldMap; /* ---------------------------------------------------------------------- */ /** * A `TypedSizedFieldBase` is the base class for fields that contain a * statically known number of scalars of a statically known type per pixel * in a `FieldCollection`. The actual data for all pixels is * stored in `TypedSizeFieldBase::values`. * `TypedSizedFieldBase` is the base class for `MatrixField` and * `TensorField`. */ template class TypedSizedFieldBase : public TypedField { friend class FieldMap; friend class FieldMap; public: //! for compatibility checks constexpr static auto nb_components{NbComponents}; using Parent = TypedField; //!< base class using Scalar = T; //!< for type checking using Base = typename Parent::Base; //!< root base class //! storage container using Storage_t = typename Parent::Storage_t; //! Plain type that is being mapped (Eigen lingo) using EigenRep_t = Eigen::Array; //! maps returned when iterating over field using EigenMap_t = Eigen::Map; //! maps returned when iterating over field using ConstEigenMap_t = Eigen::Map; //! constructor - TypedSizedFieldBase(std::string unique_name, FieldCollection &collection); + TypedSizedFieldBase(std::string unique_name, + FieldCollection & collection); virtual ~TypedSizedFieldBase() = default; //! add a new value at the end of the field template - inline void push_back(const Eigen::DenseBase &value); + inline void push_back(const Eigen::DenseBase & value); //! add a new scalar value at the end of the field template - inline std::enable_if_t push_back(const T &value); + inline std::enable_if_t push_back(const T & value); /** * returns an upcasted reference to a field, or throws an * exception if the field is incompatible */ - static TypedSizedFieldBase &check_ref(Base &other); + static TypedSizedFieldBase & check_ref(Base & other); /** * returns an upcasted reference to a field, or throws an * exception if the field is incompatible */ - static const TypedSizedFieldBase &check_ref(const Base &other); + static const TypedSizedFieldBase & check_ref(const Base & other); //! return a map representing the entire field as a single `Eigen::Array` inline EigenMap_t eigen(); //! return a map representing the entire field as a single `Eigen::Array` inline ConstEigenMap_t eigen() const; /** * return a map representing the entire field as a single * dynamically sized `Eigen::Array` (for python bindings) */ inline typename Parent::EigenMap_t dyn_eigen() { return Parent::eigen(); } //! inner product between compatible fields template inline Real inner_product( - const TypedSizedFieldBase &other) + const TypedSizedFieldBase & other) const; protected: //! returns a raw pointer to the entry, for `Eigen::Map` - inline T *get_ptr_to_entry(const size_t &&index); + inline T * get_ptr_to_entry(const size_t && index); //! returns a raw pointer to the entry, for `Eigen::Map` - inline const T *get_ptr_to_entry(const size_t &&index) const; + inline const T * get_ptr_to_entry(const size_t && index) const; }; } // namespace internal /* ---------------------------------------------------------------------- */ /** * The `TensorField` is a subclass of * `muSpectre::internal::TypedSizedFieldBase` that represents tensorial * fields, i.e. arbitrary-dimensional arrays with identical number of * rows/columns (that typically correspond to the spatial cartesian * dimensions). It is defined by the stored scalar type @a T, the tensorial * order @a order (often also called degree or rank) and the number of spatial * dimensions @a dim. */ template class TensorField : public internal::TypedSizedFieldBase { public: //! base class using Parent = internal::TypedSizedFieldBase; using Base = typename Parent::Base; //!< root base class //! polymorphic base class using Field_p = typename FieldCollection::Field_p; using Scalar = typename Parent::Scalar; //!< for type checking //! Copy constructor - TensorField(const TensorField &other) = delete; + TensorField(const TensorField & other) = delete; //! Move constructor - TensorField(TensorField &&other) = delete; + TensorField(TensorField && other) = delete; //! Destructor virtual ~TensorField() = default; //! Copy assignment operator - TensorField &operator=(const TensorField &other) = delete; + TensorField & operator=(const TensorField & other) = delete; //! Move assignment operator - TensorField &operator=(TensorField &&other) = delete; + TensorField & operator=(TensorField && other) = delete; //! return the order of the stored tensor inline Dim_t get_order() const; //! return the dimension of the stored tensor inline Dim_t get_dim() const; //! factory function template - friend FieldType &make_field(std::string unique_name, - CollectionType &collection, Args &&... args); + friend FieldType & make_field(std::string unique_name, + CollectionType & collection, Args &&... args); //! return a reference or throw an exception if `other` is incompatible - static TensorField &check_ref(Base &other) { + static TensorField & check_ref(Base & other) { return static_cast(Parent::check_ref(other)); } //! return a reference or throw an exception if `other` is incompatible - static const TensorField &check_ref(const Base &other) { + static const TensorField & check_ref(const Base & other) { return static_cast(Parent::check_ref(other)); } /** * Convenience functions to return a map onto this field. A map allows * iteration over all pixels. The map's iterator returns an object that * represents the underlying mathematical structure of the field and * implements common linear algebra operations on it. * Specifically, this function returns * - A `MatrixFieldMap` with @a dim rows and one column if the tensorial * order @a order is unity. * - A `MatrixFieldMap` with @a dim rows and @a dim columns if the tensorial * order @a order is 2. * - A `T4MatrixFieldMap` if the tensorial order is 4. */ inline decltype(auto) get_map(); /** * Convenience functions to return a map onto this field. A map allows * iteration over all pixels. The map's iterator returns an object that * represents the underlying mathematical structure of the field and * implements common linear algebra operations on it. * Specifically, this function returns * - A `MatrixFieldMap` with @a dim rows and one column if the tensorial * order @a order is unity. * - A `MatrixFieldMap` with @a dim rows and @a dim columns if the tensorial * order @a order is 2. * - A `T4MatrixFieldMap` if the tensorial order is 4. */ inline decltype(auto) get_const_map(); /** * Convenience functions to return a map onto this field. A map allows * iteration over all pixels. The map's iterator returns an object that * represents the underlying mathematical structure of the field and * implements common linear algebra operations on it. * Specifically, this function returns * - A `MatrixFieldMap` with @a dim rows and one column if the tensorial * order @a order is unity. * - A `MatrixFieldMap` with @a dim rows and @a dim columns if the tensorial * order @a order is 2. * - A `T4MatrixFieldMap` if the tensorial order is 4. */ inline decltype(auto) get_map() const; /** * creates a `TensorField` same size and type as this, but all * entries are zero. Convenience function */ - inline TensorField &get_zeros_like(std::string unique_name) const; + inline TensorField & get_zeros_like(std::string unique_name) const; protected: //! constructor protected! - TensorField(std::string unique_name, FieldCollection &collection); + TensorField(std::string unique_name, FieldCollection & collection); private: }; /* ---------------------------------------------------------------------- */ /** * The `MatrixField` is subclass of `muSpectre::internal::TypedSizedFieldBase` * that represents matrix fields, i.e. a two dimensional arrays, defined by * the stored scalar type @a T and the number of rows @a NbRow and columns * @a NbCol of the matrix. */ template class MatrixField : public internal::TypedSizedFieldBase { public: //! base class using Parent = internal::TypedSizedFieldBase; using Base = typename Parent::Base; //!< root base class //! polymorphic base field ptr to store using Field_p = std::unique_ptr>; //! Copy constructor - MatrixField(const MatrixField &other) = delete; + MatrixField(const MatrixField & other) = delete; //! Move constructor - MatrixField(MatrixField &&other) = delete; + MatrixField(MatrixField && other) = delete; //! Destructor virtual ~MatrixField() = default; //! Copy assignment operator - MatrixField &operator=(const MatrixField &other) = delete; + MatrixField & operator=(const MatrixField & other) = delete; //! Move assignment operator - MatrixField &operator=(MatrixField &&other) = delete; + MatrixField & operator=(MatrixField && other) = delete; //! returns the number of rows inline Dim_t get_nb_row() const; //! returns the number of columns inline Dim_t get_nb_col() const; //! factory function template - friend FieldType &make_field(std::string unique_name, - CollectionType &collection, Args &&... args); + friend FieldType & make_field(std::string unique_name, + CollectionType & collection, Args &&... args); //! returns a `MatrixField` reference if `other` is a compatible field - static MatrixField &check_ref(Base &other) { + static MatrixField & check_ref(Base & other) { return static_cast(Parent::check_ref(other)); } //! returns a `MatrixField` reference if `other` is a compatible field - static const MatrixField &check_ref(const Base &other) { + static const MatrixField & check_ref(const Base & other) { return static_cast(Parent::check_ref(other)); } /** * Convenience functions to return a map onto this field. A map allows * iteration over all pixels. The map's iterator returns an object that * represents the underlying mathematical structure of the field and * implements common linear algebra operations on it. * Specifically, this function returns * - A `ScalarFieldMap` if @a NbRows and @a NbCols are unity. * - A `MatrixFieldMap` with @a NbRows rows and @a NbCols columns * otherwise. */ inline decltype(auto) get_map(); /** * Convenience functions to return a map onto this field. A map allows * iteration over all pixels. The map's iterator returns an object that * represents the underlying mathematical structure of the field and * implements common linear algebra operations on it. * Specifically, this function returns * - A `ScalarFieldMap` if @a NbRows and @a NbCols are unity. * - A `MatrixFieldMap` with @a NbRows rows and @a NbCols columns * otherwise. */ inline decltype(auto) get_const_map(); /** * Convenience functions to return a map onto this field. A map allows * iteration over all pixels. The map's iterator returns an object that * represents the underlying mathematical structure of the field and * implements common linear algebra operations on it. * Specifically, this function returns * - A `ScalarFieldMap` if @a NbRows and @a NbCols are unity. * - A `MatrixFieldMap` with @a NbRows rows and @a NbCols columns * otherwise. */ inline decltype(auto) get_map() const; /** * creates a `MatrixField` same size and type as this, but all * entries are zero. Convenience function */ - inline MatrixField &get_zeros_like(std::string unique_name) const; + inline MatrixField & get_zeros_like(std::string unique_name) const; protected: //! constructor protected! - MatrixField(std::string unique_name, FieldCollection &collection); + MatrixField(std::string unique_name, FieldCollection & collection); private: }; /* ---------------------------------------------------------------------- */ //! convenience alias ( template using ScalarField = MatrixField; /* ---------------------------------------------------------------------- */ // Implementations /* ---------------------------------------------------------------------- */ namespace internal { /* ---------------------------------------------------------------------- */ template TypedSizedFieldBase::TypedSizedFieldBase( - std::string unique_name, FieldCollection &collection) + std::string unique_name, FieldCollection & collection) : Parent(unique_name, collection, NbComponents) { static_assert( (std::is_arithmetic::value || std::is_same::value), "Use TypedSizedFieldBase for integer, real or complex scalars for T"); static_assert(NbComponents > 0, "Only fields with more than 0 components"); } /* ---------------------------------------------------------------------- */ template TypedSizedFieldBase & TypedSizedFieldBase::check_ref( - Base &other) { + Base & other) { if (typeid(T).hash_code() != other.get_stored_typeid().hash_code()) { std::stringstream err_str{}; err_str << "Cannot create a reference of type '" << typeid(T).name() << "' for field '" << other.get_name() << "' of type '" << other.get_stored_typeid().name() << "'"; throw std::runtime_error(err_str.str()); } // check size compatibility if (NbComponents != other.get_nb_components()) { std::stringstream err_str{}; err_str << "Cannot create a reference to a field with " << NbComponents << " components " << "for field '" << other.get_name() << "' with " << other.get_nb_components() << " components"; throw std::runtime_error{err_str.str()}; } return static_cast(other); } /* ---------------------------------------------------------------------- */ template const TypedSizedFieldBase & TypedSizedFieldBase::check_ref( - const Base &other) { + const Base & other) { if (typeid(T).hash_code() != other.get_stored_typeid().hash_code()) { std::stringstream err_str{}; err_str << "Cannot create a reference of type '" << typeid(T).name() << "' for field '" << other.get_name() << "' of type '" << other.get_stored_typeid().name() << "'"; throw std::runtime_error(err_str.str()); } // check size compatibility if (NbComponents != other.get_nb_components()) { std::stringstream err_str{}; err_str << "Cannot create a reference toy a field with " << NbComponents << " components " << "for field '" << other.get_name() << "' with " << other.get_nb_components() << " components"; throw std::runtime_error{err_str.str()}; } return static_cast(other); } /* ---------------------------------------------------------------------- */ template auto TypedSizedFieldBase::eigen() -> EigenMap_t { return EigenMap_t(this->data(), NbComponents, this->size()); } /* ---------------------------------------------------------------------- */ template auto TypedSizedFieldBase::eigen() const -> ConstEigenMap_t { return ConstEigenMap_t(this->data(), NbComponents, this->size()); } /* ---------------------------------------------------------------------- */ template template Real TypedSizedFieldBase::inner_product( - const TypedSizedFieldBase &other) - const { + const TypedSizedFieldBase & + other) const { return (this->eigen() * other.eigen()).sum(); } /* ---------------------------------------------------------------------- */ template - T *TypedSizedFieldBase::get_ptr_to_entry( - const size_t &&index) { + T * TypedSizedFieldBase::get_ptr_to_entry( + const size_t && index) { return this->data_ptr + NbComponents * std::move(index); } /* ---------------------------------------------------------------------- */ template const T * TypedSizedFieldBase::get_ptr_to_entry( - const size_t &&index) const { + const size_t && index) const { return this->data_ptr + NbComponents * std::move(index); } /* ---------------------------------------------------------------------- */ template template void TypedSizedFieldBase::push_back( - const Eigen::DenseBase &value) { + const Eigen::DenseBase & value) { static_assert(Derived::SizeAtCompileTime == NbComponents, "You provided an array with the wrong number of entries."); static_assert((Derived::RowsAtCompileTime == 1) or (Derived::ColsAtCompileTime == 1), "You have not provided a column or row vector."); static_assert(not FieldCollection::Global, "You can only push_back data into local field " "collections."); for (Dim_t i = 0; i < NbComponents; ++i) { this->values.push_back(value(i)); } ++this->current_size; this->data_ptr = &this->values.front(); } /* ---------------------------------------------------------------------- */ template template std::enable_if_t TypedSizedFieldBase::push_back( - const T &value) { + const T & value) { static_assert(scalar_store, "SFINAE"); this->values.push_back(value); ++this->current_size; this->data_ptr = &this->values.front(); } } // namespace internal /* ---------------------------------------------------------------------- */ template TensorField::TensorField( - std::string unique_name, FieldCollection &collection) + std::string unique_name, FieldCollection & collection) : Parent(unique_name, collection) {} /* ---------------------------------------------------------------------- */ template Dim_t TensorField::get_order() const { return order; } /* ---------------------------------------------------------------------- */ template Dim_t TensorField::get_dim() const { return dim; } /* ---------------------------------------------------------------------- */ template MatrixField::MatrixField( - std::string unique_name, FieldCollection &collection) + std::string unique_name, FieldCollection & collection) : Parent(unique_name, collection) {} /* ---------------------------------------------------------------------- */ template Dim_t MatrixField::get_nb_col() const { return NbCol; } /* ---------------------------------------------------------------------- */ template Dim_t MatrixField::get_nb_row() const { return NbRow; } } // namespace muSpectre #include "common/field_map.hh" namespace muSpectre { namespace internal { /* ---------------------------------------------------------------------- */ /** * defines the default mapped type obtained when calling * `muSpectre::TensorField::get_map()` */ template struct tensor_map_type {}; /// specialisation for vectors template struct tensor_map_type { //! use this type using type = MatrixFieldMap; }; /// specialisation to second-order tensors (matrices) template struct tensor_map_type { //! use this type using type = MatrixFieldMap; }; /// specialisation to fourth-order tensors template struct tensor_map_type { //! use this type using type = T4MatrixFieldMap; }; /* ---------------------------------------------------------------------- */ /** * defines the default mapped type obtained when calling * `muSpectre::MatrixField::get_map()` */ template struct matrix_map_type { //! mapping type using type = MatrixFieldMap; }; //! specialisation to scalar fields template struct matrix_map_type { //! mapping type using type = ScalarFieldMap; }; } // namespace internal /* ---------------------------------------------------------------------- */ template auto TensorField::get_map() -> decltype(auto) { constexpr bool map_constness{false}; using RawMap_t = typename internal::tensor_map_type::type; return RawMap_t(*this); } /* ---------------------------------------------------------------------- */ template auto TensorField::get_const_map() -> decltype(auto) { constexpr bool map_constness{true}; using RawMap_t = typename internal::tensor_map_type::type; return RawMap_t(*this); } /* ---------------------------------------------------------------------- */ template auto TensorField::get_map() const -> decltype(auto) { constexpr bool map_constness{true}; using RawMap_t = typename internal::tensor_map_type::type; return RawMap_t(*this); } /* ---------------------------------------------------------------------- */ template auto TensorField::get_zeros_like( std::string unique_name) const -> TensorField & { return make_field(unique_name, this->collection); } /* ---------------------------------------------------------------------- */ template auto MatrixField::get_map() -> decltype(auto) { constexpr bool map_constness{false}; using RawMap_t = typename internal::matrix_map_type::type; return RawMap_t(*this); } /* ---------------------------------------------------------------------- */ template auto MatrixField::get_const_map() -> decltype(auto) { constexpr bool map_constness{true}; using RawMap_t = typename internal::matrix_map_type::type; return RawMap_t(*this); } /* ---------------------------------------------------------------------- */ template auto MatrixField::get_map() const -> decltype(auto) { constexpr bool map_constness{true}; using RawMap_t = typename internal::matrix_map_type::type; return RawMap_t(*this); } /* ---------------------------------------------------------------------- */ template auto MatrixField::get_zeros_like( std::string unique_name) const -> MatrixField & { return make_field(unique_name, this->collection); } } // namespace muSpectre #endif // SRC_COMMON_FIELD_HH_ diff --git a/src/common/field_base.hh b/src/common/field_base.hh index 63d0b91..3dfc84c 100644 --- a/src/common/field_base.hh +++ b/src/common/field_base.hh @@ -1,209 +1,211 @@ /** * file field_base.hh * * @author Till Junge * * @date 10 Apr 2018 * * @brief Virtual base class for fields * * Copyright © 2018 Till Junge * * µSpectre 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, 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 Lesser General Public License * along with µSpectre; see the file COPYING. If not, write to the * Free Software Foundation, Inc., 59 Temple Place - Suite 330, * * Boston, MA 02111-1307, USA. * * Additional permission under GNU GPL version 3 section 7 * * If you modify this Program, or any covered work, by linking or combining it * with proprietary FFT implementations or numerical libraries, containing parts * covered by the terms of those libraries' licenses, the licensors of this * Program grant you additional permission to convey the resulting work. */ #ifndef SRC_COMMON_FIELD_BASE_HH_ #define SRC_COMMON_FIELD_BASE_HH_ #include #include namespace muSpectre { /* ---------------------------------------------------------------------- */ /** * base class for field collection-related exceptions */ class FieldCollectionError : public std::runtime_error { public: //! constructor - explicit FieldCollectionError(const std::string &what) + explicit FieldCollectionError(const std::string & what) : std::runtime_error(what) {} //! constructor - explicit FieldCollectionError(const char *what) + explicit FieldCollectionError(const char * what) : std::runtime_error(what) {} }; /// base class for field-related exceptions class FieldError : public FieldCollectionError { using Parent = FieldCollectionError; public: //! constructor - explicit FieldError(const std::string &what) : Parent(what) {} + explicit FieldError(const std::string & what) : Parent(what) {} //! constructor - explicit FieldError(const char *what) : Parent(what) {} + explicit FieldError(const char * what) : Parent(what) {} }; /** * Thrown when a associating a field map to and incompatible field * is attempted */ class FieldInterpretationError : public FieldError { public: //! constructor - explicit FieldInterpretationError(const std::string &what) + explicit FieldInterpretationError(const std::string & what) : FieldError(what) {} //! constructor - explicit FieldInterpretationError(const char *what) : FieldError(what) {} + explicit FieldInterpretationError(const char * what) : FieldError(what) {} }; namespace internal { /* ---------------------------------------------------------------------- */ /** * Virtual base class for all fields. A field represents * meta-information for the per-pixel storage for a scalar, vector * or tensor quantity and is therefore the abstract class defining * the field. It is used for type and size checking at runtime and * for storage of polymorphic pointers to fully typed and sized * fields. `FieldBase` (and its children) are templated with a * specific `FieldCollection` (derived from * `muSpectre::FieldCollectionBase`). A `FieldCollection` stores * multiple fields that all apply to the same set of * pixels. Addressing and managing the data for all pixels is * handled by the `FieldCollection`. Note that `FieldBase` does * not know anything about about mathematical operations on the * data or how to iterate over all pixels. Mapping the raw data * onto for instance Eigen maps and iterating over those is * handled by the `FieldMap`. */ - template class FieldBase { + template + class FieldBase { protected: //! constructor //! unique name (whithin Collection) //! number of components //! collection to which this field belongs (eg, material, cell) FieldBase(std::string unique_name, size_t nb_components, - FieldCollection &collection); + FieldCollection & collection); public: using collection_t = FieldCollection; //!< for type checks //! Copy constructor - FieldBase(const FieldBase &other) = delete; + FieldBase(const FieldBase & other) = delete; //! Move constructor - FieldBase(FieldBase &&other) = delete; + FieldBase(FieldBase && other) = delete; //! Destructor virtual ~FieldBase() = default; //! Copy assignment operator - FieldBase &operator=(const FieldBase &other) = delete; + FieldBase & operator=(const FieldBase & other) = delete; //! Move assignment operator - FieldBase &operator=(FieldBase &&other) = delete; + FieldBase & operator=(FieldBase && other) = delete; /* ---------------------------------------------------------------------- */ //! Identifying accessors //! return field name - inline const std::string &get_name() const; + inline const std::string & get_name() const; //! return field type // inline const Field_t & get_type() const; //! return my collection (for iterating) - inline const FieldCollection &get_collection() const; + inline const FieldCollection & get_collection() const; //! return number of components (e.g., dimensions) of this field - inline const size_t &get_nb_components() const; + inline const size_t & get_nb_components() const; //! return type_id of stored type - virtual const std::type_info &get_stored_typeid() const = 0; + virtual const std::type_info & get_stored_typeid() const = 0; //! number of pixels in the field virtual size_t size() const = 0; //! add a pad region to the end of the field buffer; required for //! using this as e.g. an FFT workspace virtual void set_pad_size(size_t pad_size_) = 0; //! pad region size virtual size_t get_pad_size() const { return this->pad_size; } //! initialise field to zero (do more complicated initialisations through //! fully typed maps) virtual void set_zero() = 0; //! give access to collections friend FieldCollection; //! give access to collection's base class using FParent_t = typename FieldCollection::Parent; friend FParent_t; protected: /* ---------------------------------------------------------------------- */ //! allocate memory etc virtual void resize(size_t size) = 0; const std::string name; //!< the field's unique name const size_t nb_components; //!< number of components per entry //! reference to the collection this field belongs to - FieldCollection &collection; + FieldCollection & collection; size_t pad_size; //!< size of padding region at end of buffer private: }; /* ---------------------------------------------------------------------- */ // Implementations /* ---------------------------------------------------------------------- */ template FieldBase::FieldBase(std::string unique_name, size_t nb_components_, - FieldCollection &collection_) + FieldCollection & collection_) : name(unique_name), nb_components(nb_components_), collection(collection_), pad_size{0} {} /* ---------------------------------------------------------------------- */ template - inline const std::string &FieldBase::get_name() const { + inline const std::string & FieldBase::get_name() const { return this->name; } /* ---------------------------------------------------------------------- */ template inline const FieldCollection & FieldBase::get_collection() const { return this->collection; } /* ---------------------------------------------------------------------- */ template - inline const size_t &FieldBase::get_nb_components() const { + inline const size_t & + FieldBase::get_nb_components() const { return this->nb_components; } } // namespace internal } // namespace muSpectre #endif // SRC_COMMON_FIELD_BASE_HH_ diff --git a/src/common/field_collection_base.hh b/src/common/field_collection_base.hh index bb9cf43..c54fbe4 100644 --- a/src/common/field_collection_base.hh +++ b/src/common/field_collection_base.hh @@ -1,358 +1,359 @@ /** * @file field_collection_base.hh * * @author Till Junge * * @date 05 Nov 2017 * * @brief Base class for field collections * * Copyright © 2017 Till Junge * * µSpectre 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, 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 Lesser General Public License * along with µSpectre; see the file COPYING. If not, write to the * Free Software Foundation, Inc., 59 Temple Place - Suite 330, * * Boston, MA 02111-1307, USA. * * Additional permission under GNU GPL version 3 section 7 * * If you modify this Program, or any covered work, by linking or combining it * with proprietary FFT implementations or numerical libraries, containing parts * covered by the terms of those libraries' licenses, the licensors of this * Program grant you additional permission to convey the resulting work. */ #ifndef SRC_COMMON_FIELD_COLLECTION_BASE_HH_ #define SRC_COMMON_FIELD_COLLECTION_BASE_HH_ #include "common/common.hh" #include "common/field.hh" #include "common/statefield.hh" #include #include namespace muSpectre { /* ---------------------------------------------------------------------- */ /** `FieldCollectionBase` is the base class for collections of fields. All * fields in a field collection have the same number of pixels. The field * collection is templated with @a DimS is the spatial dimension (i.e. * whether the simulation domain is one, two or three-dimensional). * All fields within a field collection have a unique string identifier. * A `FieldCollectionBase` is therefore comparable to a dictionary of fields * that live on the same grid. * `FieldCollectionBase` has the specialisations `GlobalFieldCollection` and * `LocalFieldCollection`. */ template class FieldCollectionBase { public: //! polymorphic base type to store using Field_t = internal::FieldBase; template using TypedField_t = TypedField; using Field_p = std::unique_ptr; //!< stored type using StateField_t = StateFieldBase; template using TypedStateField_t = TypedStateField; using StateField_p = std::unique_ptr; using Ccoord = Ccoord_t; //!< cell coordinates type //! Default constructor FieldCollectionBase(); //! Copy constructor - FieldCollectionBase(const FieldCollectionBase &other) = delete; + FieldCollectionBase(const FieldCollectionBase & other) = delete; //! Move constructor - FieldCollectionBase(FieldCollectionBase &&other) = delete; + FieldCollectionBase(FieldCollectionBase && other) = delete; //! Destructor virtual ~FieldCollectionBase() = default; //! Copy assignment operator - FieldCollectionBase &operator=(const FieldCollectionBase &other) = delete; + FieldCollectionBase & operator=(const FieldCollectionBase & other) = delete; //! Move assignment operator - FieldCollectionBase &operator=(FieldCollectionBase &&other) = delete; + FieldCollectionBase & operator=(FieldCollectionBase && other) = delete; //! Register a new field (fields need to be in heap, so I want to keep them //! as shared pointers - void register_field(Field_p &&field); + void register_field(Field_p && field); //! Register a new field (fields need to be in heap, so I want to keep them //! as shared pointers - void register_statefield(StateField_p &&field); + void register_statefield(StateField_p && field); //! for return values of iterators constexpr inline static Dim_t spatial_dim(); //! for return values of iterators inline Dim_t get_spatial_dim() const; //! return names of all stored fields std::vector get_field_names() const { std::vector names{}; - for (auto &tup : this->fields) { + for (auto & tup : this->fields) { names.push_back(std::get<0>(tup)); } return names; } //! return names of all state fields std::vector get_statefield_names() const { std::vector names{}; - for (auto &tup : this->statefields) { + for (auto & tup : this->statefields) { names.push_back(std::get<0>(tup)); } return names; } //! retrieve field by unique_name - inline Field_t &operator[](std::string unique_name); + inline Field_t & operator[](std::string unique_name); //! retrieve field by unique_name with bounds checking - inline Field_t &at(std::string unique_name); + inline Field_t & at(std::string unique_name); //! retrieve typed field by unique_name template - inline TypedField_t &get_typed_field(std::string unique_name); + inline TypedField_t & get_typed_field(std::string unique_name); //! retrieve state field by unique_prefix with bounds checking template inline TypedStateField_t & get_typed_statefield(std::string unique_prefix); //! retrieve state field by unique_prefix with bounds checking - inline StateField_t &get_statefield(std::string unique_prefix) { + inline StateField_t & get_statefield(std::string unique_prefix) { return *(this->statefields.at(unique_prefix)); } //! retrieve state field by unique_prefix with bounds checking - inline const StateField_t &get_statefield(std::string unique_prefix) const { + inline const StateField_t & + get_statefield(std::string unique_prefix) const { return *(this->statefields.at(unique_prefix)); } /** * retrieve current value of typed state field by unique_prefix with * bounds checking */ template - inline TypedField_t &get_current(std::string unique_prefix); + inline TypedField_t & get_current(std::string unique_prefix); /** * retrieve old value of typed state field by unique_prefix with * bounds checking */ template - inline const TypedField_t &get_old(std::string unique_prefix, - size_t nb_steps_ago = 1) const; + inline const TypedField_t & get_old(std::string unique_prefix, + size_t nb_steps_ago = 1) const; //! returns size of collection, this refers to the number of pixels handled //! by the collection, not the number of fields inline size_t size() const { return this->size_; } //! check whether a field is present - bool check_field_exists(const std::string &unique_name); + bool check_field_exists(const std::string & unique_name); //! check whether the collection is initialised bool initialised() const { return this->is_initialised; } protected: std::map fields{}; //!< contains the field ptrs //! contains ptrs to state fields std::map statefields{}; bool is_initialised{false}; //!< to handle double initialisation correctly const Uint id; //!< unique identifier static Uint counter; //!< used to assign unique identifiers size_t size_{0}; //!< holds the number of pixels after initialisation private: }; /* ---------------------------------------------------------------------- */ template Uint FieldCollectionBase::counter{0}; /* ---------------------------------------------------------------------- */ template FieldCollectionBase::FieldCollectionBase() : id(counter++) {} /* ---------------------------------------------------------------------- */ template void FieldCollectionBase::register_field( - Field_p &&field) { - auto &&search_it = this->fields.find(field->get_name()); - auto &&does_exist = search_it != this->fields.end(); + Field_p && field) { + auto && search_it = this->fields.find(field->get_name()); + auto && does_exist = search_it != this->fields.end(); if (does_exist) { std::stringstream err_str; err_str << "a field named '" << field->get_name() << "' is already registered in this field collection. " << "Currently registered fields: "; std::string prelude{""}; - for (const auto &name_field_pair : this->fields) { + for (const auto & name_field_pair : this->fields) { err_str << prelude << '\'' << name_field_pair.first << '\''; prelude = ", "; } throw FieldCollectionError(err_str.str()); } if (this->is_initialised) { field->resize(this->size()); } this->fields[field->get_name()] = std::move(field); } /* ---------------------------------------------------------------------- */ template void FieldCollectionBase::register_statefield( - StateField_p &&field) { - auto &&search_it = this->statefields.find(field->get_prefix()); - auto &&does_exist = search_it != this->statefields.end(); + StateField_p && field) { + auto && search_it = this->statefields.find(field->get_prefix()); + auto && does_exist = search_it != this->statefields.end(); if (does_exist) { std::stringstream err_str; err_str << "a state field named '" << field->get_prefix() << "' is already registered in this field collection. " << "Currently registered fields: "; std::string prelude{""}; - for (const auto &name_field_pair : this->statefields) { + for (const auto & name_field_pair : this->statefields) { err_str << prelude << '\'' << name_field_pair.first << '\''; prelude = ", "; } throw FieldCollectionError(err_str.str()); } this->statefields[field->get_prefix()] = std::move(field); } /* ---------------------------------------------------------------------- */ template constexpr Dim_t FieldCollectionBase::spatial_dim() { return DimS; } /* ---------------------------------------------------------------------- */ template Dim_t FieldCollectionBase::get_spatial_dim() const { return DimS; } /* ---------------------------------------------------------------------- */ template auto FieldCollectionBase:: operator[](std::string unique_name) -> Field_t & { return *(this->fields[unique_name]); } /* ---------------------------------------------------------------------- */ template auto FieldCollectionBase::at(std::string unique_name) -> Field_t & { return *(this->fields.at(unique_name)); } /* ---------------------------------------------------------------------- */ template bool FieldCollectionBase::check_field_exists( - const std::string &unique_name) { + const std::string & unique_name) { return this->fields.find(unique_name) != this->fields.end(); } //! retrieve typed field by unique_name template template auto FieldCollectionBase::get_typed_field( std::string unique_name) -> TypedField_t & { - auto &unqualified_field{this->at(unique_name)}; + auto & unqualified_field{this->at(unique_name)}; if (unqualified_field.get_stored_typeid().hash_code() != typeid(T).hash_code()) { std::stringstream err{}; err << "Field '" << unique_name << "' is of type " << unqualified_field.get_stored_typeid().name() << ", but should be of type " << typeid(T).name() << std::endl; throw FieldCollectionError(err.str()); } return static_cast &>(unqualified_field); } /* ---------------------------------------------------------------------- */ //! retrieve state field by unique_prefix with bounds checking template template auto FieldCollectionBase::get_typed_statefield( std::string unique_prefix) -> TypedStateField_t & { - auto &unqualified_statefield{this->get_statefield(unique_prefix)}; + auto & unqualified_statefield{this->get_statefield(unique_prefix)}; if (unqualified_statefield.get_stored_typeid().hash_code() != typeid(T).hash_code()) { std::stringstream err{}; err << "Statefield '" << unique_prefix << "' is of type " << unqualified_statefield.get_stored_typeid().name() << ", but should be of type " << typeid(T).name() << std::endl; throw FieldCollectionError(err.str()); } return static_cast &>(unqualified_statefield); } /* ---------------------------------------------------------------------- */ template template auto FieldCollectionBase::get_current( std::string unique_prefix) -> TypedField_t & { - auto &unqualified_statefield = this->get_statefield(unique_prefix); + auto & unqualified_statefield = this->get_statefield(unique_prefix); //! check for correct underlying fundamental type if (unqualified_statefield.get_stored_typeid().hash_code() != typeid(T).hash_code()) { std::stringstream err{}; err << "StateField '" << unique_prefix << "' is of type " << unqualified_statefield.get_stored_typeid().name() << ", but should be of type " << typeid(T).name() << std::endl; throw FieldCollectionError(err.str()); } using Typed_t = TypedStateField; - auto &typed_field{static_cast(unqualified_statefield)}; + auto & typed_field{static_cast(unqualified_statefield)}; return typed_field.get_current_field(); } /* ---------------------------------------------------------------------- */ /* ---------------------------------------------------------------------- */ template template auto FieldCollectionBase::get_old( std::string unique_prefix, size_t nb_steps_ago) const -> const TypedField_t & { - auto &unqualified_statefield = this->get_statefield(unique_prefix); + auto & unqualified_statefield = this->get_statefield(unique_prefix); //! check for correct underlying fundamental type if (unqualified_statefield.get_stored_typeid().hash_code() != typeid(T).hash_code()) { std::stringstream err{}; err << "StateField '" << unique_prefix << "' is of type " << unqualified_statefield.get_stored_typeid().name() << ", but should be of type " << typeid(T).name() << std::endl; throw FieldCollectionError(err.str()); } using Typed_t = TypedStateField; - auto &typed_field{static_cast(unqualified_statefield)}; + auto & typed_field{static_cast(unqualified_statefield)}; return typed_field.get_old_field(nb_steps_ago); } } // namespace muSpectre #endif // SRC_COMMON_FIELD_COLLECTION_BASE_HH_ diff --git a/src/common/field_collection_global.hh b/src/common/field_collection_global.hh index 9bdb490..a4290e6 100644 --- a/src/common/field_collection_global.hh +++ b/src/common/field_collection_global.hh @@ -1,213 +1,214 @@ /** * @file field_collection_global.hh * * @author Till Junge * * @date 05 Nov 2017 * * @brief FieldCollection base-class for global fields * * Copyright © 2017 Till Junge * * µSpectre 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, 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 Lesser General Public License * along with µSpectre; see the file COPYING. If not, write to the * Free Software Foundation, Inc., 59 Temple Place - Suite 330, * * Boston, MA 02111-1307, USA. * * Additional permission under GNU GPL version 3 section 7 * * If you modify this Program, or any covered work, by linking or combining it * with proprietary FFT implementations or numerical libraries, containing parts * covered by the terms of those libraries' licenses, the licensors of this * Program grant you additional permission to convey the resulting work. */ #ifndef SRC_COMMON_FIELD_COLLECTION_GLOBAL_HH_ #define SRC_COMMON_FIELD_COLLECTION_GLOBAL_HH_ #include "common/ccoord_operations.hh" #include "common/field_collection_base.hh" namespace muSpectre { /** * forward declaration */ - template class LocalFieldCollection; + template + class LocalFieldCollection; /** `GlobalFieldCollection` derives from `FieldCollectionBase` and stores * global fields that live throughout the whole computational domain, i.e. * are defined for each pixel. */ template class GlobalFieldCollection : public FieldCollectionBase> { public: //! for compile time check constexpr static bool Global{true}; using Parent = FieldCollectionBase>; //!< base class //! helpful for functions that fill global fields from local fields using LocalFieldCollection_t = LocalFieldCollection; //! helpful for functions that fill global fields from local fields using GlobalFieldCollection_t = GlobalFieldCollection; using Ccoord = typename Parent::Ccoord; //!< cell coordinates type using Field_p = typename Parent::Field_p; //!< spatial coordinates type //! iterator over all pixels contained it the collection using iterator = typename CcoordOps::Pixels::iterator; //! Default constructor GlobalFieldCollection(); //! Copy constructor - GlobalFieldCollection(const GlobalFieldCollection &other) = delete; + GlobalFieldCollection(const GlobalFieldCollection & other) = delete; //! Move constructor - GlobalFieldCollection(GlobalFieldCollection &&other) = default; + GlobalFieldCollection(GlobalFieldCollection && other) = default; //! Destructor virtual ~GlobalFieldCollection() = default; //! Copy assignment operator GlobalFieldCollection & - operator=(const GlobalFieldCollection &other) = delete; + operator=(const GlobalFieldCollection & other) = delete; //! Move assignment operator - GlobalFieldCollection &operator=(GlobalFieldCollection &&other) = default; + GlobalFieldCollection & operator=(GlobalFieldCollection && other) = default; /** allocate memory, etc. At this point, the collection is informed aboud the size and shape of the domain (through the sizes parameter). The job of initialise is to make sure that all fields are either of size 0, in which case they need to be allocated, or are of the same size as the product of 'sizes' (if standard strides apply) any field of a different size is wrong. TODO: check whether it makes sense to put a runtime check here **/ inline void initialise(Ccoord sizes, Ccoord locations); //! return subdomain resolutions - inline const Ccoord &get_sizes() const; + inline const Ccoord & get_sizes() const; //! return subdomain locations - inline const Ccoord &get_locations() const; + inline const Ccoord & get_locations() const; //! returns the linear index corresponding to cell coordinates template - inline size_t get_index(CcoordRef &&ccoord) const; + inline size_t get_index(CcoordRef && ccoord) const; //! returns the cell coordinates corresponding to a linear index inline Ccoord get_ccoord(size_t index) const; inline iterator begin() const; //!< returns iterator to first pixel inline iterator end() const; //!< returns iterator past the last pixel //! return spatial dimension (template parameter) static constexpr inline Dim_t spatial_dim() { return DimS; } //! return globalness at compile time static constexpr inline bool is_global() { return Global; } protected: //! number of discretisation cells in each of the DimS spatial directions Ccoord sizes{}; Ccoord locations{}; CcoordOps::Pixels pixels{}; //!< helper to iterate over the grid private: }; /* ---------------------------------------------------------------------- */ template GlobalFieldCollection::GlobalFieldCollection() : Parent() {} /* ---------------------------------------------------------------------- */ template void GlobalFieldCollection::initialise(Ccoord sizes, Ccoord locations) { if (this->is_initialised) { throw std::runtime_error("double initialisation"); } this->pixels = CcoordOps::Pixels(sizes, locations); this->size_ = CcoordOps::get_size(sizes); this->sizes = sizes; this->locations = locations; std::for_each( - std::begin(this->fields), std::end(this->fields), [this](auto &&item) { - auto &&field = *item.second; + std::begin(this->fields), std::end(this->fields), [this](auto && item) { + auto && field = *item.second; const auto field_size = field.size(); if (field_size == 0) { field.resize(this->size()); } else if (field_size != this->size()) { std::stringstream err_stream; err_stream << "Field '" << field.get_name() << "' contains " << field_size << " entries, but the field collection " << "has " << this->size() << " pixels"; throw FieldCollectionError(err_stream.str()); } }); this->is_initialised = true; } //----------------------------------------------------------------------------// //! return subdomain resolutions template const typename GlobalFieldCollection::Ccoord & GlobalFieldCollection::get_sizes() const { return this->sizes; } //----------------------------------------------------------------------------// //! return subdomain locations template const typename GlobalFieldCollection::Ccoord & GlobalFieldCollection::get_locations() const { return this->locations; } //----------------------------------------------------------------------------// //! returns the cell coordinates corresponding to a linear index template typename GlobalFieldCollection::Ccoord GlobalFieldCollection::get_ccoord(size_t index) const { return CcoordOps::get_ccoord(this->get_sizes(), this->get_locations(), std::move(index)); } /* ---------------------------------------------------------------------- */ template typename GlobalFieldCollection::iterator GlobalFieldCollection::begin() const { return this->pixels.begin(); } /* ---------------------------------------------------------------------- */ template typename GlobalFieldCollection::iterator GlobalFieldCollection::end() const { return this->pixels.end(); } //-------------------------------------------------------------------------// //! returns the linear index corresponding to cell coordinates template template - size_t GlobalFieldCollection::get_index(CcoordRef &&ccoord) const { + size_t GlobalFieldCollection::get_index(CcoordRef && ccoord) const { static_assert( std::is_same>>::value, "can only be called with values or references of Ccoord"); return CcoordOps::get_index(this->get_sizes(), this->get_locations(), std::forward(ccoord)); } } // namespace muSpectre #endif // SRC_COMMON_FIELD_COLLECTION_GLOBAL_HH_ diff --git a/src/common/field_collection_local.hh b/src/common/field_collection_local.hh index 7135b69..cc5424f 100644 --- a/src/common/field_collection_local.hh +++ b/src/common/field_collection_local.hh @@ -1,196 +1,199 @@ /** * @file field_collection_local.hh * * @author Till Junge * * @date 05 Nov 2017 * * @brief FieldCollection base-class for local fields * * Copyright © 2017 Till Junge * * µSpectre 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, 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 Lesser General Public License * along with µSpectre; see the file COPYING. If not, write to the * Free Software Foundation, Inc., 59 Temple Place - Suite 330, * * Boston, MA 02111-1307, USA. * * Additional permission under GNU GPL version 3 section 7 * * If you modify this Program, or any covered work, by linking or combining it * with proprietary FFT implementations or numerical libraries, containing parts * covered by the terms of those libraries' licenses, the licensors of this * Program grant you additional permission to convey the resulting work. */ #ifndef SRC_COMMON_FIELD_COLLECTION_LOCAL_HH_ #define SRC_COMMON_FIELD_COLLECTION_LOCAL_HH_ #include "common/field_collection_base.hh" namespace muSpectre { /** * forward declaration */ - template class GlobalFieldCollection; + template + class GlobalFieldCollection; /** `LocalFieldCollection` derives from `FieldCollectionBase` and stores * local fields, i.e. fields that are only defined for a subset of all pixels * in the computational domain. The coordinates of these active pixels are * explicitly stored by this field collection. * `LocalFieldCollection::add_pixel` allows to add individual pixels to the * field collection. */ template class LocalFieldCollection : public FieldCollectionBase> { public: //! for compile time check constexpr static bool Global{false}; //! base class using Parent = FieldCollectionBase>; //! helpful for functions that fill local fields from global fields using GlobalFieldCollection_t = GlobalFieldCollection; //! helpful for functions that fill local fields from global fields using LocalFieldCollection_t = LocalFieldCollection; using Ccoord = typename Parent::Ccoord; //!< cell coordinates type using Field_p = typename Parent::Field_p; //!< field pointer using ccoords_container = std::vector; //!< list of pixels //! iterator over managed pixels using iterator = typename ccoords_container::iterator; //! const iterator over managed pixels using const_iterator = typename ccoords_container::const_iterator; //! Default constructor LocalFieldCollection(); //! Copy constructor - LocalFieldCollection(const LocalFieldCollection &other) = delete; + LocalFieldCollection(const LocalFieldCollection & other) = delete; //! Move constructor - LocalFieldCollection(LocalFieldCollection &&other) = delete; + LocalFieldCollection(LocalFieldCollection && other) = delete; //! Destructor virtual ~LocalFieldCollection() = default; //! Copy assignment operator - LocalFieldCollection &operator=(const LocalFieldCollection &other) = delete; + LocalFieldCollection & + operator=(const LocalFieldCollection & other) = delete; //! Move assignment operator - LocalFieldCollection &operator=(LocalFieldCollection &&other) = delete; + LocalFieldCollection & operator=(LocalFieldCollection && other) = delete; //! add a pixel/voxel to the field collection - inline void add_pixel(const Ccoord &local_ccoord); + inline void add_pixel(const Ccoord & local_ccoord); /** allocate memory, etc. at this point, the field collection knows how many entries it should have from the size of the coords containes (which grows by one every time add_pixel is called. The job of initialise is to make sure that all fields are either of size 0, in which case they need to be allocated, or are of the same size as the product of 'sizes' any field of a different size is wrong TODO: check whether it makes sense to put a runtime check here **/ inline void initialise(); //! returns the linear index corresponding to cell coordinates template - inline size_t get_index(CcoordRef &&ccoord) const; + inline size_t get_index(CcoordRef && ccoord) const; //! returns the cell coordinates corresponding to a linear index inline Ccoord get_ccoord(size_t index) const; //! iterator to first pixel inline iterator begin() { return this->ccoords.begin(); } //! iterator past last pixel inline iterator end() { return this->ccoords.end(); } //! const iterator to first pixel inline const_iterator begin() const { return this->ccoords.cbegin(); } //! const iterator past last pixel inline const_iterator end() const { return this->ccoords.cend(); } //! return globalness at compile time static constexpr inline bool is_global() { return Global; } protected: //! container of pixel coords for non-global collections ccoords_container ccoords{}; //! container of indices for non-global collections (slow!) std::map indices{}; private: }; /* ---------------------------------------------------------------------- */ template LocalFieldCollection::LocalFieldCollection() : Parent() {} /* ---------------------------------------------------------------------- */ template - void LocalFieldCollection::add_pixel(const Ccoord &local_ccoord) { + void LocalFieldCollection::add_pixel(const Ccoord & local_ccoord) { if (this->is_initialised) { throw FieldCollectionError( "once a field collection has been initialised, you can't add new " "pixels."); } this->indices[local_ccoord] = this->ccoords.size(); this->ccoords.push_back(local_ccoord); this->size_++; } /* ---------------------------------------------------------------------- */ - template void LocalFieldCollection::initialise() { + template + void LocalFieldCollection::initialise() { if (this->is_initialised) { throw std::runtime_error("double initialisation"); } std::for_each( - std::begin(this->fields), std::end(this->fields), [this](auto &&item) { - auto &&field = *item.second; + std::begin(this->fields), std::end(this->fields), [this](auto && item) { + auto && field = *item.second; const auto field_size = field.size(); if (field_size == 0) { field.resize(this->size()); } else if (field_size != this->size()) { std::stringstream err_stream; err_stream << "Field '" << field.get_name() << "' contains " << field_size << " entries, but the field collection " << "has " << this->size() << " pixels"; throw FieldCollectionError(err_stream.str()); } }); this->is_initialised = true; } //----------------------------------------------------------------------------// //! returns the linear index corresponding to cell coordinates template template - size_t LocalFieldCollection::get_index(CcoordRef &&ccoord) const { + size_t LocalFieldCollection::get_index(CcoordRef && ccoord) const { static_assert( std::is_same>>::value, "can only be called with values or references of Ccoord"); return this->indices.at(std::forward(ccoord)); } //----------------------------------------------------------------------------// //! returns the cell coordinates corresponding to a linear index template typename LocalFieldCollection::Ccoord LocalFieldCollection::get_ccoord(size_t index) const { return this->ccoords[std::move(index)]; } } // namespace muSpectre #endif // SRC_COMMON_FIELD_COLLECTION_LOCAL_HH_ diff --git a/src/common/field_helpers.hh b/src/common/field_helpers.hh index c74bd7c..ff13a68 100644 --- a/src/common/field_helpers.hh +++ b/src/common/field_helpers.hh @@ -1,59 +1,59 @@ /** * file field_helpers.hh * * @author Till Junge * * @date 30 Aug 2018 * * @brief helper functions that needed to be sequestered to avoid circular * inclusions * * Copyright © 2018 Till Junge * * µSpectre 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, 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 Lesser General Public License * along with µSpectre; see the file COPYING. If not, write to the * Free Software Foundation, Inc., 59 Temple Place - Suite 330, * * Boston, MA 02111-1307, USA. * * Additional permission under GNU GPL version 3 section 7 * * If you modify this Program, or any covered work, by linking or combining it * with proprietary FFT implementations or numerical libraries, containing parts * covered by the terms of those libraries' licenses, the licensors of this * Program grant you additional permission to convey the resulting work. */ #ifndef SRC_COMMON_FIELD_HELPERS_HH_ #define SRC_COMMON_FIELD_HELPERS_HH_ #include namespace muSpectre { /** * Factory function, guarantees that only fields get created that * are properly registered and linked to a collection. */ template - inline FieldType &make_field(std::string unique_name, - FieldCollection &collection, Args &&... args) { + inline FieldType & make_field(std::string unique_name, + FieldCollection & collection, Args &&... args) { std::unique_ptr ptr{ new FieldType(unique_name, collection, args...)}; - auto &retref{*ptr}; + auto & retref{*ptr}; collection.register_field(std::move(ptr)); return retref; } } // namespace muSpectre #endif // SRC_COMMON_FIELD_HELPERS_HH_ diff --git a/src/common/field_map.hh b/src/common/field_map.hh index 16ad8ae..900857f 100644 --- a/src/common/field_map.hh +++ b/src/common/field_map.hh @@ -1,257 +1,259 @@ /** * @file field_map.hh * * @author Till Junge * * @date 26 Sep 2017 * * @brief just and indirection to include all iterables defined for fields * * Copyright © 2017 Till Junge * * µSpectre 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, 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 Lesser General Public License * along with µSpectre; see the file COPYING. If not, write to the * Free Software Foundation, Inc., 59 Temple Place - Suite 330, * * Boston, MA 02111-1307, USA. * * Additional permission under GNU GPL version 3 section 7 * * If you modify this Program, or any covered work, by linking or combining it * with proprietary FFT implementations or numerical libraries, containing parts * covered by the terms of those libraries' licenses, the licensors of this * Program grant you additional permission to convey the resulting work. */ #include "common/field_map_tensor.hh" #include "common/field_map_matrixlike.hh" #include "common/field_map_scalar.hh" #include #include #include #ifndef SRC_COMMON_FIELD_MAP_HH_ #define SRC_COMMON_FIELD_MAP_HH_ namespace muSpectre { /** * allows to iterate over raw data as if it were a FieldMap. This is * particularly useful when interacting with external solvers, such * as scipy and Eigen * @param EigenMap needs to be statically sized a Eigen::Map * * @warning This type is not safe for re-use. I.e., after there has * been an assignment to the underlying eigen array, the * `RawFieldMap` might be invalidated! */ - template class RawFieldMap { + template + class RawFieldMap { public: /** * determining the constness of the mapped array required in order * to formulate the constructors const-correctly */ constexpr static bool IsConst{std::is_const< std::remove_pointer_t>::value}; //! short-hand for the basic scalar type using T = typename EigenMap::Scalar; //! raw pointer type to store using T_ptr = std::conditional_t; //! input array (~field) type to be mapped using FieldVec_t = std::conditional_t; //! Plain mapped Eigen type using EigenPlain = typename EigenMap::PlainObject; //! Default constructor RawFieldMap() = delete; //! constructor from a *contiguous* array RawFieldMap(Eigen::Map vec, Dim_t nb_rows = EigenMap::RowsAtCompileTime, Dim_t nb_cols = EigenMap::ColsAtCompileTime) : data{vec.data()}, nb_rows{nb_rows}, nb_cols{nb_cols}, nb_components{nb_rows * nb_cols}, nb_pixels(vec.size() / nb_components) { - if ((nb_rows == Eigen::Dynamic) or(nb_cols == Eigen::Dynamic)) { + if ((nb_rows == Eigen::Dynamic) or (nb_cols == Eigen::Dynamic)) { throw FieldError( "You have to specify the number of rows and columns if you map a " "dynamically sized Eigen Map type."); } - if ((nb_rows < 1) or(nb_cols < 1)) { + if ((nb_rows < 1) or (nb_cols < 1)) { throw FieldError("Only positive numbers of rows and columns make " "sense"); } if (vec.size() % this->nb_components != 0) { std::stringstream err{}; err << "The vector size of " << vec.size() << " is not an integer multiple of the size of value_type, which " << "is " << this->nb_components << "."; throw std::runtime_error(err.str()); } } //! constructor from a *contiguous* array RawFieldMap(Eigen::Ref vec, Dim_t nb_rows = EigenMap::RowsAtCompileTime, Dim_t nb_cols = EigenMap::ColsAtCompileTime) : data{vec.data()}, nb_rows{nb_rows}, nb_cols{nb_cols}, nb_components{nb_rows * nb_cols}, nb_pixels(vec.size() / nb_components) { if (vec.size() % this->nb_components != 0) { std::stringstream err{}; err << "The vector size of " << vec.size() << " is not an integer multiple of the size of value_type, which " << "is " << this->nb_components << "."; throw std::runtime_error(err.str()); } } //! Copy constructor - RawFieldMap(const RawFieldMap &other) = delete; + RawFieldMap(const RawFieldMap & other) = delete; //! Move constructor - RawFieldMap(RawFieldMap &&other) = default; + RawFieldMap(RawFieldMap && other) = default; //! Destructor virtual ~RawFieldMap() = default; //! Copy assignment operator - RawFieldMap &operator=(const RawFieldMap &other) = delete; + RawFieldMap & operator=(const RawFieldMap & other) = delete; //! Move assignment operator - RawFieldMap &operator=(RawFieldMap &&other) = delete; + RawFieldMap & operator=(RawFieldMap && other) = delete; //! returns number of EigenMaps stored within the array size_t size() const { return this->nb_pixels; } //! forward declaration of iterator type - template class iterator_t; + template + class iterator_t; using iterator = iterator_t; using const_iterator = iterator_t; //! returns an iterator to the first element iterator begin() { return iterator{*this, 0}; } const_iterator begin() const { return const_iterator{*this, 0}; } //! returns an iterator past the last element iterator end() { return iterator{*this, this->size()}; } const_iterator end() const { return const_iterator{*this, this->size()}; } //! evaluates the average of the field EigenPlain mean() const { using T_t = EigenPlain; T_t mean(T_t::Zero(this->nb_rows, this->nb_cols)); - for (auto &&val : *this) { + for (auto && val : *this) { mean += val; } mean /= this->size(); return mean; } protected: inline T_ptr get_data() { return data; } inline const T_ptr get_data() const { return data; } //! raw data pointer (ugly, I know) T_ptr data; const Dim_t nb_rows; const Dim_t nb_cols; const Dim_t nb_components; //! number of EigenMaps stored within the array size_t nb_pixels; private: }; /** * Small iterator class to be used with the RawFieldMap */ template template class RawFieldMap::iterator_t { public: //! short hand for the raw field map's type using Parent = RawFieldMap; //! the map needs to be friend in order to access the protected constructor friend Parent; //! stl compliance using value_type = std::conditional_t< IsConst, Eigen::Map, EigenMap>; using T_ptr = std::conditional_t; //! stl compliance using iterator_category = std::forward_iterator_tag; //! Default constructor iterator_t() = delete; //! Copy constructor - iterator_t(const iterator_t &other) = default; + iterator_t(const iterator_t & other) = default; //! Move constructor - iterator_t(iterator_t &&other) = default; + iterator_t(iterator_t && other) = default; //! Destructor virtual ~iterator_t() = default; //! Copy assignment operator - iterator_t &operator=(const iterator_t &other) = default; + iterator_t & operator=(const iterator_t & other) = default; //! Move assignment operator - iterator_t &operator=(iterator_t &&other) = default; + iterator_t & operator=(iterator_t && other) = default; //! pre-increment - inline iterator_t &operator++() { + inline iterator_t & operator++() { ++this->index; return *this; } //! dereference inline value_type operator*() { return value_type(raw_ptr + this->map.nb_components * index, this->map.nb_rows, this->map.nb_cols); } //! inequality - inline bool operator!=(const iterator_t &other) const { + inline bool operator!=(const iterator_t & other) const { return this->index != other.index; } //! equality - inline bool operator==(const iterator_t &other) const { + inline bool operator==(const iterator_t & other) const { return this->index == other.index; } protected: //! protected constructor - iterator_t(const Parent &map, size_t start) + iterator_t(const Parent & map, size_t start) : raw_ptr{map.get_data()}, map{map}, index{start} {} template iterator_t(std::enable_if_t map, size_t start) : raw_ptr{map.data}, map{map}, index{start} { static_assert(dummy_non_const == not IsConst, "SFINAE"); } //! raw data T_ptr raw_ptr; //! ref to underlying map - const Parent ↦ + const Parent & map; //! currently pointed-to element size_t index; private: }; } // namespace muSpectre #endif // SRC_COMMON_FIELD_MAP_HH_ diff --git a/src/common/field_map_base.hh b/src/common/field_map_base.hh index 627fe95..3e6903c 100644 --- a/src/common/field_map_base.hh +++ b/src/common/field_map_base.hh @@ -1,888 +1,891 @@ /** * @file field_map.hh * * @author Till Junge * * @date 12 Sep 2017 * * @brief Defined a strongly defines proxy that iterates efficiently over a * field * * Copyright © 2017 Till Junge * * µSpectre 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, 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 Lesser General Public License * along with µSpectre; see the file COPYING. If not, write to the * Free Software Foundation, Inc., 59 Temple Place - Suite 330, * * Boston, MA 02111-1307, USA. * * Additional permission under GNU GPL version 3 section 7 * * If you modify this Program, or any covered work, by linking or combining it * with proprietary FFT implementations or numerical libraries, containing parts * covered by the terms of those libraries' licenses, the licensors of this * Program grant you additional permission to convey the resulting work. */ #ifndef SRC_COMMON_FIELD_MAP_BASE_HH_ #define SRC_COMMON_FIELD_MAP_BASE_HH_ #include "common/common.hh" #include "common/field.hh" #include "field_collection_base.hh" #include #include #include #include namespace muSpectre { namespace internal { /** * Forward-declaration */ template class TypedSizedFieldBase; //! little helper to automate creation of const maps without duplication - template struct const_corrector { + template + struct const_corrector { //! non-const type using type = typename T::reference; }; //! specialisation for constant case - template struct const_corrector { + template + struct const_corrector { //! const type using type = typename T::const_reference; }; //! convenience alias template using const_corrector_t = typename const_corrector::type; //----------------------------------------------------------------------------// /** * `FieldMap` provides two central mechanisms: * - Map a field (that knows only about the size of the underlying object, * onto the mathematical object (reprensented by the respective Eigen class) * that provides linear algebra functionality. * - Provide an iterator that allows to iterate over all pixels. * A field is represented by `FieldBase` or a derived class. * `FieldMap` has the specialisations `MatrixLikeFieldMap`, * `ScalarFieldMap` and `TensorFieldMap`. */ template class FieldMap { static_assert((NbComponents != 0), "Fields with now components make no sense."); /* * Eigen::Dynamic is equal to -1, and is a legal value, hence * the following peculiar check */ static_assert( (NbComponents > -2), "Fields with a negative number of components make no sense."); public: //! Fundamental type stored using Scalar = T; //! number of scalars per entry constexpr static auto nb_components{NbComponents}; //! non-constant version of field using TypedField_nc = std::conditional_t< (NbComponents >= 1), TypedSizedFieldBase, TypedField>; //! field type as seen from iterator using TypedField_t = std::conditional_t; using Field = typename TypedField_nc::Base; //!< iterated field type //! const-correct field type using Field_c = std::conditional_t; using size_type = std::size_t; //!< stl conformance using pointer = std::conditional_t; //!< stl conformance //! Default constructor FieldMap() = delete; //! constructor - explicit FieldMap(Field_c &field); + explicit FieldMap(Field_c & field); //! constructor with run-time cost (for python and debugging) template - explicit FieldMap(TypedSizedFieldBase &field); + explicit FieldMap(TypedSizedFieldBase & field); //! Copy constructor - FieldMap(const FieldMap &other) = default; + FieldMap(const FieldMap & other) = default; //! Move constructor - FieldMap(FieldMap &&other) = default; + FieldMap(FieldMap && other) = default; //! Destructor virtual ~FieldMap() = default; //! Copy assignment operator - FieldMap &operator=(const FieldMap &other) = delete; + FieldMap & operator=(const FieldMap & other) = delete; //! Move assignment operator - FieldMap &operator=(FieldMap &&other) = delete; + FieldMap & operator=(FieldMap && other) = delete; //! give human-readable field map type virtual std::string info_string() const = 0; //! return field name - inline const std::string &get_name() const; + inline const std::string & get_name() const; //! return my collection (for iterating) - inline const FieldCollection &get_collection() const; + inline const FieldCollection & get_collection() const; //! member access needs to be implemented by inheriting classes // inline value_type operator[](size_t index); // inline value_type operator[](Ccoord ccord); //! check compatibility (must be called by all inheriting classes at the //! end of their constructors inline void check_compatibility(); //! convenience call to collection's size method inline size_t size() const; //! compile-time compatibility check - template struct is_compatible; + template + struct is_compatible; /** * iterates over all pixels in the `muSpectre::FieldCollection` * and dereferences to an Eigen map to the currently used field. */ template class iterator; /** * Simple iterable proxy wrapper object around a FieldMap. When * iterated over, rather than dereferencing to the reference * type of iterator, it dereferences to a tuple of the pixel, * and the reference type of iterator */ - template class enumerator; + template + class enumerator; - TypedField_t &get_field() { return this->field; } + TypedField_t & get_field() { return this->field; } protected: //! raw pointer to entry (for Eigen Map) inline pointer get_ptr_to_entry(size_t index); //! raw pointer to entry (for Eigen Map) - inline const T *get_ptr_to_entry(size_t index) const; - const FieldCollection &collection; //!< collection holding Field - TypedField_t &field; //!< mapped Field + inline const T * get_ptr_to_entry(size_t index) const; + const FieldCollection & collection; //!< collection holding Field + TypedField_t & field; //!< mapped Field private: }; /** * iterates over all pixels in the `muSpectre::FieldCollection` * and dereferences to an Eigen map to the currently used field. */ template template class FieldMap::iterator { static_assert(!((ConstIter == false) && (ConstField == true)), "You can't have a non-const iterator over a const " "field"); public: //! for use by enumerator using FullyTypedFieldMap_t = FullyTypedFieldMap; //! stl conformance using value_type = const_corrector_t; //! stl conformance using const_value_type = const_corrector_t; //! stl conformance using pointer = typename FullyTypedFieldMap::pointer; //! stl conformance using difference_type = std::ptrdiff_t; //! stl conformance using iterator_category = std::random_access_iterator_tag; //! cell coordinates type using Ccoord = typename FieldCollection::Ccoord; //! stl conformance using reference = typename FullyTypedFieldMap::reference; //! fully typed reference as seen by the iterator using TypedMap_t = std::conditional_t; //! Default constructor iterator() = delete; //! constructor inline iterator(TypedMap_t & fieldmap, bool begin = true); //! constructor for random access inline iterator(TypedMap_t & fieldmap, size_t index); //! Move constructor - iterator(iterator &&other) = default; + iterator(iterator && other) = default; //! Destructor virtual ~iterator() = default; //! Copy assignment operator - iterator &operator=(const iterator &other) = default; + iterator & operator=(const iterator & other) = default; //! Move assignment operator - iterator &operator=(iterator &&other) = default; + iterator & operator=(iterator && other) = default; //! pre-increment - inline iterator &operator++(); + inline iterator & operator++(); //! post-increment inline iterator operator++(int); //! dereference inline value_type operator*(); //! dereference inline const_value_type operator*() const; //! member of pointer inline pointer operator->(); //! pre-decrement - inline iterator &operator--(); + inline iterator & operator--(); //! post-decrement inline iterator operator--(int); //! access subscripting inline value_type operator[](difference_type diff); //! access subscripting inline const_value_type operator[](const difference_type diff) const; //! equality - inline bool operator==(const iterator &other) const; + inline bool operator==(const iterator & other) const; //! inequality - inline bool operator!=(const iterator &other) const; + inline bool operator!=(const iterator & other) const; //! div. comparisons - inline bool operator<(const iterator &other) const; + inline bool operator<(const iterator & other) const; //! div. comparisons - inline bool operator<=(const iterator &other) const; + inline bool operator<=(const iterator & other) const; //! div. comparisons - inline bool operator>(const iterator &other) const; + inline bool operator>(const iterator & other) const; //! div. comparisons - inline bool operator>=(const iterator &other) const; + inline bool operator>=(const iterator & other) const; //! additions, subtractions and corresponding assignments inline iterator operator+(difference_type diff) const; //! additions, subtractions and corresponding assignments inline iterator operator-(difference_type diff) const; //! additions, subtractions and corresponding assignments - inline iterator &operator+=(difference_type diff); + inline iterator & operator+=(difference_type diff); //! additions, subtractions and corresponding assignments - inline iterator &operator-=(difference_type diff); + inline iterator & operator-=(difference_type diff); //! get pixel coordinates inline Ccoord get_ccoord() const; //! ostream operator (mainly for debugging) - friend std::ostream &operator<<(std::ostream &os, const iterator &it) { + friend std::ostream & operator<<(std::ostream & os, const iterator & it) { if (ConstIter) { os << "const "; } os << "iterator on field '" << it.fieldmap.get_name() << "', entry " << it.index; return os; } protected: //! Copy constructor - iterator(const iterator &other) = default; + iterator(const iterator & other) = default; - const FieldCollection &collection; //!< collection of the field - TypedMap_t & fieldmap; //!< ref to the field itself + const FieldCollection & collection; //!< collection of the field + TypedMap_t & fieldmap; //!< ref to the field itself size_t index; //!< index of currently pointed-to pixel private: }; /* ---------------------------------------------------------------------- */ template template class FieldMap::enumerator { public: //! fully typed reference as seen by the iterator using TypedMap_t = typename Iterator::TypedMap_t; //! Default constructor enumerator() = delete; //! constructor with field mapped enumerator(TypedMap_t & field_map) : field_map{field_map} {} /** * similar to iterators of the field map, but dereferences to a * tuple containing the cell coordinates and teh corresponding * entry */ class iterator; iterator begin() { return iterator(this->field_map); } iterator end() { return iterator(this->field_map, false); } protected: TypedMap_t & field_map; }; /* ---------------------------------------------------------------------- */ template template class FieldMap::enumerator::iterator { public: //! cell coordinates type using Ccoord = typename FieldCollection::Ccoord; //! stl conformance using value_type = std::tuple; //! stl conformance using const_value_type = std::tuple; //! stl conformance using difference_type = std::ptrdiff_t; //! stl conformance using iterator_category = std::random_access_iterator_tag; //! stl conformance using reference = std::tuple; //! Default constructor iterator() = delete; //! constructor for begin/end - iterator(TypedMap_t & fieldmap, bool begin = true) : it{fieldmap, begin} { - } + iterator(TypedMap_t & fieldmap, bool begin = true) + : it{fieldmap, begin} {} //! constructor for random access iterator(TypedMap_t & fieldmap, size_t index) : it{fieldmap, index} {} //! constructor from iterator - iterator(const SimpleIterator &it) : it{it} {} + iterator(const SimpleIterator & it) : it{it} {} //! Copy constructor - iterator(const iterator &other) = default; + iterator(const iterator & other) = default; //! Move constructor - iterator(iterator &&other) = default; + iterator(iterator && other) = default; //! Destructor virtual ~iterator() = default; //! Copy assignment operator - iterator &operator=(const iterator &other) = default; + iterator & operator=(const iterator & other) = default; //! Move assignment operator - iterator &operator=(iterator &&other) = default; + iterator & operator=(iterator && other) = default; //! pre-increment - iterator &operator++() { + iterator & operator++() { ++(this->it); return *this; } //! post-increment iterator operator++(int) { iterator current = *this; ++(this->it); return current; } //! dereference value_type operator*() { return value_type{it.get_ccoord(), *this->it}; } //! dereference const_value_type operator*() const { return const_value_type{it.get_ccoord(), *this->it}; } //! pre-decrement - iterator &operator--() { + iterator & operator--() { --(this->it); return *this; } //! post-decrement iterator operator--(int) { iterator current = *this; --(this->it); return current; } //! access subscripting value_type operator[](difference_type diff) { SimpleIterator accessed{this->it + diff}; return *accessed; } //! access subscripting const_value_type operator[](const difference_type diff) const { SimpleIterator accessed{this->it + diff}; return *accessed; } //! equality - bool operator==(const iterator &other) const { + bool operator==(const iterator & other) const { return this->it == other.it; } //! inequality - bool operator!=(const iterator &other) const { + bool operator!=(const iterator & other) const { return this->it != other.it; } //! div. comparisons - bool operator<(const iterator &other) const { + bool operator<(const iterator & other) const { return this->it < other.it; } //! div. comparisons - bool operator<=(const iterator &other) const { + bool operator<=(const iterator & other) const { return this->it <= other.it; } //! div. comparisons - bool operator>(const iterator &other) const { + bool operator>(const iterator & other) const { return this->it > other.it; } //! div. comparisons - bool operator>=(const iterator &other) const { + bool operator>=(const iterator & other) const { return this->it >= other.it; } //! additions, subtractions and corresponding assignments iterator operator+(difference_type diff) const { return iterator{this->it + diff}; } //! additions, subtractions and corresponding assignments iterator operator-(difference_type diff) const { return iterator{this->it - diff}; } //! additions, subtractions and corresponding assignments - iterator &operator+=(difference_type diff) { this->it += diff; } + iterator & operator+=(difference_type diff) { this->it += diff; } //! additions, subtractions and corresponding assignments - iterator &operator-=(difference_type diff) { this->it -= diff; } + iterator & operator-=(difference_type diff) { this->it -= diff; } protected: SimpleIterator it; private: }; } // namespace internal namespace internal { /* ---------------------------------------------------------------------- */ template FieldMap::FieldMap( - Field_c &field) + Field_c & field) : collection(field.get_collection()), field(static_cast(field)) { - static_assert((NbComponents > 0) or - (NbComponents == Eigen::Dynamic), + static_assert((NbComponents > 0) or (NbComponents == Eigen::Dynamic), "Only fields with more than 0 components allowed"); } /* ---------------------------------------------------------------------- */ template template FieldMap::FieldMap( - TypedSizedFieldBase &field) + TypedSizedFieldBase & field) : collection(field.get_collection()), field(static_cast(field)) { static_assert( std::is_same::value, "The field does not have the expected FieldCollection type"); static_assert(std::is_same::value, "The field does not have the expected Scalar type"); static_assert( (NbC == NbComponents), "The field does not have the expected number of components"); } /* ---------------------------------------------------------------------- */ template void FieldMap::check_compatibility() { if (typeid(T).hash_code() != this->field.get_stored_typeid().hash_code()) { std::string err{"Cannot create a Map of type '" + this->info_string() + "' for field '" + this->field.get_name() + "' of type '" + this->field.get_stored_typeid().name() + "'"}; throw FieldInterpretationError(err); } // check size compatibility if ((NbComponents != Dim_t(this->field.get_nb_components())) and (NbComponents != Eigen::Dynamic)) { throw FieldInterpretationError( "Cannot create a Map of type '" + this->info_string() + "' for field '" + this->field.get_name() + "' with " + std::to_string(this->field.get_nb_components()) + " components"); } } /* ---------------------------------------------------------------------- */ template size_t FieldMap::size() const { return this->collection.size(); } /* ---------------------------------------------------------------------- */ template template struct FieldMap::is_compatible { //! creates a more readable compile error constexpr static bool explain() { static_assert( std::is_same::value, "The field does not have the expected FieldCollection type"); static_assert(std::is_same::value, "The // field does not have the expected Scalar type"); static_assert( (TypedField_t::nb_components == NbComponents), "The field does not have the expected number of components"); // The static asserts wouldn't pass in the incompatible case, so this is // it return true; } //! evaluated compatibility constexpr static bool value{ std::is_base_of::value}; }; /* ---------------------------------------------------------------------- */ template const std::string & FieldMap::get_name() const { return this->field.get_name(); } /* ---------------------------------------------------------------------- */ template const FieldCollection & FieldMap::get_collection() const { return this->collection; } /* ---------------------------------------------------------------------- */ /* ---------------------------------------------------------------------- */ // Iterator implementations //! constructor template template FieldMap::iterator< FullyTypedFieldMap, ConstIter>::iterator(TypedMap_t & fieldmap, bool begin) : collection(fieldmap.get_collection()), fieldmap(fieldmap), index(begin ? 0 : fieldmap.field.size()) {} /* ---------------------------------------------------------------------- */ //! constructor for random access template template FieldMap::iterator< FullyTypedFieldMap, ConstIter>::iterator(TypedMap_t & fieldmap, size_t index) : collection(fieldmap.collection), fieldmap(fieldmap), index(index) {} /* ---------------------------------------------------------------------- */ //! pre-increment template template typename FieldMap:: template iterator & FieldMap::iterator:: operator++() { this->index++; return *this; } /* ---------------------------------------------------------------------- */ //! post-increment template template typename FieldMap:: template iterator FieldMap::iterator:: operator++(int) { iterator current = *this; this->index++; return current; } /* ---------------------------------------------------------------------- */ //! dereference template template typename FieldMap:: template iterator::value_type FieldMap::iterator:: operator*() { return this->fieldmap.operator[](this->index); } /* ---------------------------------------------------------------------- */ //! dereference template template typename FieldMap:: template iterator::const_value_type FieldMap::iterator:: operator*() const { return this->fieldmap.operator[](this->index); } /* ---------------------------------------------------------------------- */ //! member of pointer template template typename FullyTypedFieldMap::pointer FieldMap::iterator:: operator->() { return this->fieldmap.ptr_to_val_t(this->index); } /* ---------------------------------------------------------------------- */ //! pre-decrement template template typename FieldMap:: template iterator & FieldMap::iterator:: operator--() { this->index--; return *this; } /* ---------------------------------------------------------------------- */ //! post-decrement template template typename FieldMap:: template iterator FieldMap::iterator:: operator--(int) { iterator current = *this; this->index--; return current; } /* ---------------------------------------------------------------------- */ //! Access subscripting template template typename FieldMap:: template iterator::value_type FieldMap::iterator:: operator[](difference_type diff) { return this->fieldmap[this->index + diff]; } /* ---------------------------------------------------------------------- */ //! Access subscripting template template typename FieldMap:: template iterator::const_value_type FieldMap::iterator:: operator[](const difference_type diff) const { return this->fieldmap[this->index + diff]; } /* ---------------------------------------------------------------------- */ //! equality template template bool FieldMap::iterator:: - operator==(const iterator &other) const { + operator==(const iterator & other) const { return (this->index == other.index); } /* ---------------------------------------------------------------------- */ //! inquality template template bool FieldMap::iterator:: - operator!=(const iterator &other) const { + operator!=(const iterator & other) const { return !(*this == other); } /* ---------------------------------------------------------------------- */ //! div. comparisons template template bool FieldMap::iterator:: - operator<(const iterator &other) const { + operator<(const iterator & other) const { return (this->index < other.index); } template template bool FieldMap::iterator:: - operator<=(const iterator &other) const { + operator<=(const iterator & other) const { return (this->index <= other.index); } template template bool FieldMap::iterator:: - operator>(const iterator &other) const { + operator>(const iterator & other) const { return (this->index > other.index); } template template bool FieldMap::iterator:: - operator>=(const iterator &other) const { + operator>=(const iterator & other) const { return (this->index >= other.index); } /* ---------------------------------------------------------------------- */ //! additions, subtractions and corresponding assignments template template typename FieldMap:: template iterator FieldMap::iterator:: operator+(difference_type diff) const { return iterator(this->fieldmap, this->index + diff); } template template typename FieldMap:: template iterator FieldMap::iterator:: operator-(difference_type diff) const { return iterator(this->fieldmap, this->index - diff); } template template typename FieldMap:: template iterator & FieldMap::iterator:: operator+=(difference_type diff) { this->index += diff; return *this; } template template typename FieldMap:: template iterator & FieldMap::iterator:: operator-=(difference_type diff) { this->index -= diff; return *this; } /* ---------------------------------------------------------------------- */ //! get pixel coordinates template template typename FieldCollection::Ccoord FieldMap::iterator< FullyTypedFieldMap, ConstIter>::get_ccoord() const { return this->collection.get_ccoord(this->index); } ////----------------------------------------------------------------------------// // template std::ostream & operator << (std::ostream &os, // const typename FieldMap:: // template iterator & it) { // os << "iterator on field '" // << it.field.get_name() // << "', entry " << it.index; // return os; //} /* ---------------------------------------------------------------------- */ template typename FieldMap::pointer FieldMap::get_ptr_to_entry( size_t index) { return this->field.get_ptr_to_entry(std::move(index)); } /* ---------------------------------------------------------------------- */ template const T * FieldMap::get_ptr_to_entry( size_t index) const { return this->field.get_ptr_to_entry(std::move(index)); } } // namespace internal } // namespace muSpectre #endif // SRC_COMMON_FIELD_MAP_BASE_HH_ diff --git a/src/common/field_map_dynamic.hh b/src/common/field_map_dynamic.hh index 90e041a..0e8d024 100644 --- a/src/common/field_map_dynamic.hh +++ b/src/common/field_map_dynamic.hh @@ -1,220 +1,220 @@ /** * @file field_map_dynamic.hh * * @author Till Junge * * @date 24 Jul 2018 * * @brief Field map for dynamically sized maps. for use in non-critical * applications (i.e., i/o, postprocessing, etc, but *not* in a hot * loop * * Copyright © 2018 Till Junge * * µSpectre 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, 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 Lesser General Public License * along with µSpectre; see the file COPYING. If not, write to the * Free Software Foundation, Inc., 59 Temple Place - Suite 330, * * Boston, MA 02111-1307, USA. * * Additional permission under GNU GPL version 3 section 7 * * If you modify this Program, or any covered work, by linking or combining it * with proprietary FFT implementations or numerical libraries, containing parts * covered by the terms of those libraries' licenses, the licensors of this * Program grant you additional permission to convey the resulting work. */ #ifndef SRC_COMMON_FIELD_MAP_DYNAMIC_HH_ #define SRC_COMMON_FIELD_MAP_DYNAMIC_HH_ #include "common/field_map_base.hh" namespace muSpectre { /** * Maps onto any `muSpectre::TypedField` and lets you iterate over * it in the form of `Eigen::Map`. This is significantly slower than the statically sized field * maps and should only be used in non-critical contexts. */ template class TypedFieldMap : public internal::FieldMap { public: //! base class using Parent = internal::FieldMap; //! sister class with all params equal, but ConstField guaranteed true using ConstMap = TypedFieldMap; //! cell coordinates type using Ccoord = Ccoord_t; //! plain Eigen type using Arr_t = Eigen::Array; using value_type = Eigen::Map; //!< stl conformance using const_reference = Eigen::Map; //!< stl conformance //! stl conformance using reference = std::conditional_t; // since it's a resource handle using size_type = typename Parent::size_type; //!< stl conformance using pointer = std::unique_ptr; //!< stl conformance //! polymorphic base field type (for debug and python) using Field = typename Parent::Field; //! polymorphic base field type (for debug and python) using Field_c = typename Parent::Field_c; //! stl conformance using const_iterator = typename Parent::template iterator; //! stl conformance using iterator = std::conditional_t>; //! stl conformance using reverse_iterator = std::reverse_iterator; //! stl conformance using const_reverse_iterator = std::reverse_iterator; //! enumerator over a constant scalar field using const_enumerator = typename Parent::template enumerator; //! enumerator over a scalar field using enumerator = std::conditional_t>; //! give access to the protected fields friend iterator; //! Default constructor TypedFieldMap() = delete; //! Constructor - explicit TypedFieldMap(Field_c &field); + explicit TypedFieldMap(Field_c & field); //! Copy constructor - TypedFieldMap(const TypedFieldMap &other) = delete; + TypedFieldMap(const TypedFieldMap & other) = delete; //! Move constructor - TypedFieldMap(TypedFieldMap &&other) = default; + TypedFieldMap(TypedFieldMap && other) = default; //! Destructor virtual ~TypedFieldMap() = default; //! Copy assignment operator - TypedFieldMap &operator=(const TypedFieldMap &other) = delete; + TypedFieldMap & operator=(const TypedFieldMap & other) = delete; //! Assign a matrixlike value to every entry template - inline TypedFieldMap &operator=(const Eigen::EigenBase &val); + inline TypedFieldMap & operator=(const Eigen::EigenBase & val); //! Move assignment operator - TypedFieldMap &operator=(TypedFieldMap &&other) = default; + TypedFieldMap & operator=(TypedFieldMap && other) = default; //! give human-readable field map type inline std::string info_string() const final; //! member access inline reference operator[](size_type index); //! member access - inline reference operator[](const Ccoord &ccoord); + inline reference operator[](const Ccoord & ccoord); //! member access inline const_reference operator[](size_type index) const; //! member access - inline const_reference operator[](const Ccoord &ccoord) const; + inline const_reference operator[](const Ccoord & ccoord) const; //! return an iterator to first entry of field inline iterator begin() { return iterator(*this); } //! return an iterator to first entry of field inline const_iterator cbegin() const { return const_iterator(*this); } //! return an iterator to first entry of field inline const_iterator begin() const { return this->cbegin(); } //! return an iterator past the last entry of field inline iterator end() { return iterator(*this, false); } //! return an iterator past the last entry of field inline const_iterator cend() const { return const_iterator(*this, false); } //! return an iterator past the last entry of field inline const_iterator end() const { return this->cend(); } /** * return an iterable proxy to this field that can be iterated * in Ccoord-value tuples */ enumerator enumerate() { return enumerator(*this); } /** * return an iterable proxy to this field that can be iterated * in Ccoord-value tuples */ const_enumerator enumerate() const { return const_enumerator(*this); } //! evaluate the average of the field inline Arr_t mean() const; protected: //! for sad, legacy iterator use inline pointer ptr_to_val_t(size_type index); private: }; //----------------------------------------------------------------------------// template - TypedFieldMap::TypedFieldMap(Field_c &field) + TypedFieldMap::TypedFieldMap(Field_c & field) : Parent(field) { this->check_compatibility(); } //----------------------------------------------------------------------------// template std::string TypedFieldMap::info_string() const { std::stringstream info; info << "Dynamic(" << typeid(T).name() << ", " << this->field.get_nb_components() << ")"; return info.str(); } //----------------------------------------------------------------------------// template auto TypedFieldMap:: operator[](size_type index) -> reference { return reference{this->get_ptr_to_entry(index), Dim_t(this->field.get_nb_components())}; } //----------------------------------------------------------------------------// template auto TypedFieldMap:: - operator[](const Ccoord &ccoord) -> reference { + operator[](const Ccoord & ccoord) -> reference { size_t index{this->collection.get_index(ccoord)}; return (*this)[index]; } //----------------------------------------------------------------------------// template auto TypedFieldMap:: operator[](size_type index) const -> const_reference { return const_reference{this->get_ptr_to_entry(index), Dim_t(this->field.get_nb_components())}; } //----------------------------------------------------------------------------// template auto TypedFieldMap:: - operator[](const Ccoord &ccoord) const -> const_reference { + operator[](const Ccoord & ccoord) const -> const_reference { size_t index{this->collection.get_index(ccoord)}; return (*this)[index]; } } // namespace muSpectre #endif // SRC_COMMON_FIELD_MAP_DYNAMIC_HH_ diff --git a/src/common/field_map_matrixlike.hh b/src/common/field_map_matrixlike.hh index e15dbba..88f26d8 100644 --- a/src/common/field_map_matrixlike.hh +++ b/src/common/field_map_matrixlike.hh @@ -1,378 +1,383 @@ /** * @file field_map_matrixlike.hh * * @author Till Junge * * @date 26 Sep 2017 * * @brief Eigen-Matrix and -Array maps over strongly typed fields * * Copyright © 2017 Till Junge * * µSpectre 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, 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 Lesser General Public License * along with µSpectre; see the file COPYING. If not, write to the * Free Software Foundation, Inc., 59 Temple Place - Suite 330, * * Boston, MA 02111-1307, USA. * * Additional permission under GNU GPL version 3 section 7 * * If you modify this Program, or any covered work, by linking or combining it * with proprietary FFT implementations or numerical libraries, containing parts * covered by the terms of those libraries' licenses, the licensors of this * Program grant you additional permission to convey the resulting work. */ #ifndef SRC_COMMON_FIELD_MAP_MATRIXLIKE_HH_ #define SRC_COMMON_FIELD_MAP_MATRIXLIKE_HH_ #include "common/T4_map_proxy.hh" #include "common/field_map_base.hh" #include #include namespace muSpectre { namespace internal { /* ---------------------------------------------------------------------- */ /** * lists all matrix-like types consideres by * `muSpectre::internal::MatrixLikeFieldMap` */ enum class Map_t { Matrix, //!< for wrapping `Eigen::Matrix` Array, //!< for wrapping `Eigen::Array` T4Matrix //!< for wrapping `Eigen::T4Matrix` }; /** * traits structure to define the name shown when a * `muSpectre::MatrixLikeFieldMap` output into an ostream */ - template struct NameWrapper {}; + template + struct NameWrapper {}; /// specialisation for `muSpectre::ArrayFieldMap` - template <> struct NameWrapper { + template <> + struct NameWrapper { //! string to use for printing static std::string field_info_root() { return "Array"; } }; /// specialisation for `muSpectre::MatrixFieldMap` - template <> struct NameWrapper { + template <> + struct NameWrapper { //! string to use for printing static std::string field_info_root() { return "Matrix"; } }; /// specialisation for `muSpectre::T4MatrixFieldMap` - template <> struct NameWrapper { + template <> + struct NameWrapper { //! string to use for printing static std::string field_info_root() { return "T4Matrix"; } }; /* ---------------------------------------------------------------------- */ /*! * A `MatrixLikeFieldMap` is the base class for maps of matrices, arrays and * fourth-order tensors mapped onto matrices. * * It should never be necessary to call directly any of the * constructors if this class, but rather use the template aliases: * - `muSpectre::ArrayFieldMap`: iterate in the form of `Eigen::Array<...>`. * - `muSpectre::MatrixFieldMap`: iterate in the form of * `Eigen::Matrix<...>`. * - `muSpectre::T4MatrixFieldMap`: iterate in the form of * `muSpectre::T4MatMap`. */ template class MatrixLikeFieldMap : public FieldMap { public: //! base class using Parent = FieldMap; //! sister class with all params equal, but ConstField guaranteed true using ConstMap = MatrixLikeFieldMap; using T_t = EigenPlain; //!< plain Eigen type to map //! cell coordinates type using Ccoord = Ccoord_t; using value_type = EigenArray; //!< stl conformance using const_reference = EigenConstArray; //!< stl conformance //! stl conformance using reference = std::conditional_t; // since it's a resource handle using size_type = typename Parent::size_type; //!< stl conformance using pointer = std::unique_ptr; //!< stl conformance using Field = typename Parent::Field; //!< stl conformance using Field_c = typename Parent::Field_c; //!< stl conformance //! stl conformance using const_iterator = typename Parent::template iterator; //! stl conformance using iterator = std::conditional_t< ConstField, const_iterator, typename Parent::template iterator>; using reverse_iterator = std::reverse_iterator; //!< stl conformance //! stl conformance using const_reverse_iterator = std::reverse_iterator; //! enumerator over a constant scalar field using const_enumerator = typename Parent::template enumerator; //! enumerator over a scalar field using enumerator = std::conditional_t>; //! give access to the protected fields friend iterator; //! Default constructor MatrixLikeFieldMap() = delete; /** * Constructor using a (non-typed) field. Compatibility is enforced at * runtime. This should not be a performance concern, as this constructor * will not be called in anny inner loops (if used as intended). */ explicit MatrixLikeFieldMap(Field_c & field); /** * Constructor using a typed field. Compatibility is enforced * statically. It is not always possible to call this constructor, as the * type of the field might not be known at compile time. */ template - MatrixLikeFieldMap(TypedSizedFieldBase & field) //NOLINT - : Parent(field) {} + MatrixLikeFieldMap(TypedSizedFieldBase & field) // NOLINT + : Parent(field) {} //! Copy constructor - MatrixLikeFieldMap(const MatrixLikeFieldMap &other) = delete; + MatrixLikeFieldMap(const MatrixLikeFieldMap & other) = delete; //! Move constructorxo - MatrixLikeFieldMap(MatrixLikeFieldMap &&other) = default; + MatrixLikeFieldMap(MatrixLikeFieldMap && other) = default; //! Destructor virtual ~MatrixLikeFieldMap() = default; //! Copy assignment operator - MatrixLikeFieldMap &operator=(const MatrixLikeFieldMap &other) = delete; + MatrixLikeFieldMap & operator=(const MatrixLikeFieldMap & other) = delete; //! Move assignment operator - MatrixLikeFieldMap &operator=(MatrixLikeFieldMap &&other) = delete; + MatrixLikeFieldMap & operator=(MatrixLikeFieldMap && other) = delete; //! Assign a matrixlike value to every entry template inline MatrixLikeFieldMap & - operator=(const Eigen::EigenBase &val); + operator=(const Eigen::EigenBase & val); //! give human-readable field map type inline std::string info_string() const final; //! member access inline reference operator[](size_type index); //! member access - inline reference operator[](const Ccoord &ccoord); + inline reference operator[](const Ccoord & ccoord); //! member access inline const_reference operator[](size_type index) const; //! member access - inline const_reference operator[](const Ccoord &ccoord) const; + inline const_reference operator[](const Ccoord & ccoord) const; //! return an iterator to head of field for ranges inline iterator begin() { return std::move(iterator(*this)); } //! return an iterator to head of field for ranges inline const_iterator cbegin() const { return const_iterator(*this); } //! return an iterator to head of field for ranges inline const_iterator begin() const { return this->cbegin(); } //! return an iterator to tail of field for ranges inline iterator end() { return iterator(*this, false); } //! return an iterator to tail of field for ranges inline const_iterator cend() const { return const_iterator(*this, false); } //! return an iterator to tail of field for ranges inline const_iterator end() const { return this->cend(); } /** * return an iterable proxy to this field that can be iterated * in Ccoord-value tuples */ enumerator enumerate() { return enumerator(*this); } /** * return an iterable proxy to this field that can be iterated * in Ccoord-value tuples */ const_enumerator enumerate() const { return const_enumerator(*this); } //! evaluate the average of the field inline T_t mean() const; protected: //! for sad, legacy iterator use inline pointer ptr_to_val_t(size_type index); static const std::string field_info_root() { return NameWrapper::field_info_root(); } //!< for printing and debug private: }; /* ---------------------------------------------------------------------- */ template MatrixLikeFieldMap::MatrixLikeFieldMap(Field_c &field) + map_type, ConstField>::MatrixLikeFieldMap(Field_c & + field) : Parent(field) { this->check_compatibility(); } /* ---------------------------------------------------------------------- */ //! human-readable field map type template std::string MatrixLikeFieldMap::info_string() const { std::stringstream info; info << this->field_info_root() << "(" << typeid(typename EigenArray::value_type).name() << ", " << EigenArray::RowsAtCompileTime << "x" << EigenArray::ColsAtCompileTime << ")"; return info.str(); } /* ---------------------------------------------------------------------- */ //! member access template typename MatrixLikeFieldMap::reference MatrixLikeFieldMap:: operator[](size_type index) { return reference(this->get_ptr_to_entry(index)); } template typename MatrixLikeFieldMap::reference MatrixLikeFieldMap:: - operator[](const Ccoord &ccoord) { - size_t &&index{this->collection.get_index(ccoord)}; + operator[](const Ccoord & ccoord) { + size_t && index{this->collection.get_index(ccoord)}; return reference(this->get_ptr_to_entry(index)); } /* ---------------------------------------------------------------------- */ //! member access template typename MatrixLikeFieldMap::const_reference MatrixLikeFieldMap:: operator[](size_type index) const { return const_reference(this->get_ptr_to_entry(index)); } template typename MatrixLikeFieldMap::const_reference MatrixLikeFieldMap:: - operator[](const Ccoord &ccoord) const { - size_t &&index{this->collection.get_index(ccoord)}; + operator[](const Ccoord & ccoord) const { + size_t && index{this->collection.get_index(ccoord)}; return const_reference(this->get_ptr_to_entry(index)); } //----------------------------------------------------------------------------// template template MatrixLikeFieldMap & MatrixLikeFieldMap:: - operator=(const Eigen::EigenBase &val) { - for (auto &&entry : *this) { + operator=(const Eigen::EigenBase & val) { + for (auto && entry : *this) { entry = val; } return *this; } /* ---------------------------------------------------------------------- */ template typename MatrixLikeFieldMap::T_t MatrixLikeFieldMap::mean() const { T_t mean{T_t::Zero()}; - for (auto &&val : *this) { + for (auto && val : *this) { mean += val; } mean *= 1. / Real(this->size()); return mean; } /* ---------------------------------------------------------------------- */ template typename MatrixLikeFieldMap::pointer MatrixLikeFieldMap::ptr_to_val_t(size_type index) { return std::make_unique( this->get_ptr_to_entry(std::move(index))); } } // namespace internal /* ---------------------------------------------------------------------- */ //! short-hand for an Eigen matrix map as iterate template using MatrixFieldMap = internal::MatrixLikeFieldMap< FieldCollection, Eigen::Map>, Eigen::Map>, Eigen::Matrix, internal::Map_t::Matrix, ConstField>; /* ---------------------------------------------------------------------- */ //! short-hand for an Eigen matrix map as iterate template using T4MatrixFieldMap = internal::MatrixLikeFieldMap, T4MatMap, T4Mat, internal::Map_t::T4Matrix, MapConst>; /* ---------------------------------------------------------------------- */ //! short-hand for an Eigen array map as iterate template using ArrayFieldMap = internal::MatrixLikeFieldMap< FieldCollection, Eigen::Map>, Eigen::Map>, Eigen::Array, internal::Map_t::Array, ConstField>; } // namespace muSpectre #endif // SRC_COMMON_FIELD_MAP_MATRIXLIKE_HH_ diff --git a/src/common/field_map_scalar.hh b/src/common/field_map_scalar.hh index 5d4ccfc..374883f 100644 --- a/src/common/field_map_scalar.hh +++ b/src/common/field_map_scalar.hh @@ -1,241 +1,242 @@ /** * @file field_map_scalar.hh * * @author Till Junge * * @date 26 Sep 2017 * * @brief maps over scalar fields * * Copyright © 2017 Till Junge * * µSpectre 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, 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 Lesser General Public License * along with µSpectre; see the file COPYING. If not, write to the * Free Software Foundation, Inc., 59 Temple Place - Suite 330, * * Boston, MA 02111-1307, USA. * * Additional permission under GNU GPL version 3 section 7 * * If you modify this Program, or any covered work, by linking or combining it * with proprietary FFT implementations or numerical libraries, containing parts * covered by the terms of those libraries' licenses, the licensors of this * Program grant you additional permission to convey the resulting work. */ #ifndef SRC_COMMON_FIELD_MAP_SCALAR_HH_ #define SRC_COMMON_FIELD_MAP_SCALAR_HH_ #include "common/field_map_base.hh" namespace muSpectre { /** * Implements maps on scalar fields (i.e. material properties, * temperatures, etc). Maps onto a `muSpectre::internal::TypedSizedFieldBase` * and lets you iterate over it in the form of the bare type of the field. */ template class ScalarFieldMap : public internal::FieldMap { public: //! base class using Parent = internal::FieldMap; //! sister class with all params equal, but ConstField guaranteed true using ConstMap = ScalarFieldMap; //! cell coordinates type using Ccoord = Ccoord_t; using value_type = T; //!< stl conformance using const_reference = const value_type &; //!< stl conformance //! stl conformance using reference = std::conditional_t; using size_type = typename Parent::size_type; //!< stl conformance using pointer = T *; //!< stl conformance using Field = typename Parent::Field; //!< stl conformance using Field_c = typename Parent::Field_c; //!< stl conformance //! stl conformance using const_iterator = typename Parent::template iterator; //! iterator over a scalar field using iterator = std::conditional_t>; using reverse_iterator = std::reverse_iterator; //!< stl conformance //! stl conformance using const_reverse_iterator = std::reverse_iterator; //! enumerator over a constant scalar field using const_enumerator = typename Parent::template enumerator; //! enumerator over a scalar field using enumerator = std::conditional_t>; //! give access to the protected fields friend iterator; //! Default constructor ScalarFieldMap() = delete; //! constructor - explicit ScalarFieldMap(Field_c &field); + explicit ScalarFieldMap(Field_c & field); //! Copy constructor - ScalarFieldMap(const ScalarFieldMap &other) = default; + ScalarFieldMap(const ScalarFieldMap & other) = default; //! Move constructor - ScalarFieldMap(ScalarFieldMap &&other) = default; + ScalarFieldMap(ScalarFieldMap && other) = default; //! Destructor virtual ~ScalarFieldMap() = default; //! Copy assignment operator - ScalarFieldMap &operator=(const ScalarFieldMap &other) = delete; + ScalarFieldMap & operator=(const ScalarFieldMap & other) = delete; //! Move assignment operator - ScalarFieldMap &operator=(ScalarFieldMap &&other) = delete; + ScalarFieldMap & operator=(ScalarFieldMap && other) = delete; //! Assign a value to every entry - ScalarFieldMap &operator=(T val); + ScalarFieldMap & operator=(T val); //! give human-readable field map type inline std::string info_string() const final; //! member access inline reference operator[](size_type index); - inline reference operator[](const Ccoord &ccoord); + inline reference operator[](const Ccoord & ccoord); inline const_reference operator[](size_type index) const; - inline const_reference operator[](const Ccoord &ccoord) const; + inline const_reference operator[](const Ccoord & ccoord) const; //! return an iterator to the first pixel of the field iterator begin() { return iterator(*this); } //! return an iterator to the first pixel of the field const_iterator cbegin() const { return const_iterator(*this); } //! return an iterator to the first pixel of the field const_iterator begin() const { return this->cbegin(); } //! return an iterator to tail of field for ranges iterator end() { return iterator(*this, false); } //! return an iterator to tail of field for ranges const_iterator cend() const { return const_iterator(*this, false); } //! return an iterator to tail of field for ranges const_iterator end() const { return this->cend(); } /** * return an iterable proxy to this field that can be iterated * in Ccoord-value tuples */ enumerator enumerate() { return enumerator(*this); } /** * return an iterable proxy to this field that can be iterated * in Ccoord-value tuples */ const_enumerator enumerate() const { return const_enumerator(*this); } //! evaluate the average of the field inline T mean() const; protected: //! for sad, legacy iterator use inline pointer ptr_to_val_t(size_type index); //! type identifier for printing and debugging static const std::string field_info_root; private: }; /* ---------------------------------------------------------------------- */ template - ScalarFieldMap::ScalarFieldMap(Field_c &field) + ScalarFieldMap::ScalarFieldMap( + Field_c & field) : Parent(field) { this->check_compatibility(); } /* ---------------------------------------------------------------------- */ //! human-readable field map type template std::string ScalarFieldMap::info_string() const { std::stringstream info; info << "Scalar(" << typeid(T).name() << ")"; return info.str(); } /* ---------------------------------------------------------------------- */ template const std::string ScalarFieldMap::field_info_root{"Scalar"}; /* ---------------------------------------------------------------------- */ //! member access template typename ScalarFieldMap::reference ScalarFieldMap:: operator[](size_type index) { return this->get_ptr_to_entry(std::move(index))[0]; } /* ---------------------------------------------------------------------- */ //! member access template typename ScalarFieldMap::reference ScalarFieldMap:: - operator[](const Ccoord &ccoord) { - auto &&index = this->collection.get_index(std::move(ccoord)); + operator[](const Ccoord & ccoord) { + auto && index = this->collection.get_index(std::move(ccoord)); return this->get_ptr_to_entry(std::move(index))[0]; } /* ---------------------------------------------------------------------- */ //! member access template typename ScalarFieldMap::const_reference ScalarFieldMap:: operator[](size_type index) const { return this->get_ptr_to_entry(std::move(index))[0]; } /* ---------------------------------------------------------------------- */ //! member access template typename ScalarFieldMap::const_reference ScalarFieldMap:: - operator[](const Ccoord &ccoord) const { - auto &&index = this->collection.get_index(std::move(ccoord)); + operator[](const Ccoord & ccoord) const { + auto && index = this->collection.get_index(std::move(ccoord)); return this->get_ptr_to_entry(std::move(index))[0]; } /* ---------------------------------------------------------------------- */ //! Assign a value to every entry template ScalarFieldMap & ScalarFieldMap::operator=(T val) { - for (auto &scalar : *this) { + for (auto & scalar : *this) { scalar = val; } return *this; } /* ---------------------------------------------------------------------- */ template T ScalarFieldMap::mean() const { T mean{0}; - for (auto &&val : *this) { + for (auto && val : *this) { mean += val; } mean /= Real(this->size()); return mean; } } // namespace muSpectre #endif // SRC_COMMON_FIELD_MAP_SCALAR_HH_ diff --git a/src/common/field_map_tensor.hh b/src/common/field_map_tensor.hh index ac3c155..0be64ea 100644 --- a/src/common/field_map_tensor.hh +++ b/src/common/field_map_tensor.hh @@ -1,293 +1,293 @@ /** * @file field_map_tensor.hh * * @author Till Junge * * @date 26 Sep 2017 * * @brief Defines an Eigen-Tensor map over strongly typed fields * * Copyright © 2017 Till Junge * * µSpectre 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, 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 Lesser General Public License * along with µSpectre; see the file COPYING. If not, write to the * Free Software Foundation, Inc., 59 Temple Place - Suite 330, * * Boston, MA 02111-1307, USA. * * Additional permission under GNU GPL version 3 section 7 * * If you modify this Program, or any covered work, by linking or combining it * with proprietary FFT implementations or numerical libraries, containing parts * covered by the terms of those libraries' licenses, the licensors of this * Program grant you additional permission to convey the resulting work. */ #ifndef SRC_COMMON_FIELD_MAP_TENSOR_HH_ #define SRC_COMMON_FIELD_MAP_TENSOR_HH_ #include "common/eigen_tools.hh" #include "common/field_map_base.hh" #include #include namespace muSpectre { /* ---------------------------------------------------------------------- */ /** * Maps onto a `muSpectre::internal::TypedSizedFieldBase` and lets * you iterate over it in the form of `Eigen::TensorMap>` */ template class TensorFieldMap : public internal::FieldMap::Sizes::total_size, ConstField> { public: //! base class using Parent = internal::FieldMap; //! sister class with all params equal, but ConstField guaranteed true using ConstMap = TensorFieldMap; //! cell coordinates type using Ccoord = Ccoord_t; //! static tensor size using Sizes = typename SizesByOrder::Sizes; //! plain Eigen type using T_t = Eigen::TensorFixedSize; using value_type = Eigen::TensorMap; //!< stl conformance using const_reference = Eigen::TensorMap; //!< stl conformance //! stl conformance using reference = std::conditional_t; // since it's a resource handle using size_type = typename Parent::size_type; //!< stl conformance using pointer = std::unique_ptr; //!< stl conformance //! polymorphic base field type (for debug and python) using Field = typename Parent::Field; //! polymorphic base field type (for debug and python) using Field_c = typename Parent::Field_c; //! stl conformance using const_iterator = typename Parent::template iterator; //! stl conformance using iterator = std::conditional_t>; //! stl conformance using reverse_iterator = std::reverse_iterator; //! stl conformance using const_reverse_iterator = std::reverse_iterator; //! enumerator over a constant scalar field using const_enumerator = typename Parent::template enumerator; //! enumerator over a scalar field using enumerator = std::conditional_t>; //! give access to the protected fields friend iterator; //! Default constructor TensorFieldMap() = delete; //! constructor - explicit TensorFieldMap(Field_c &field); + explicit TensorFieldMap(Field_c & field); //! Copy constructor - TensorFieldMap(const TensorFieldMap &other) = delete; + TensorFieldMap(const TensorFieldMap & other) = delete; //! Move constructor - TensorFieldMap(TensorFieldMap &&other) = default; + TensorFieldMap(TensorFieldMap && other) = default; //! Destructor virtual ~TensorFieldMap() = default; //! Copy assignment operator - TensorFieldMap &operator=(const TensorFieldMap &other) = delete; + TensorFieldMap & operator=(const TensorFieldMap & other) = delete; //! Assign a matrixlike value to every entry - inline TensorFieldMap &operator=(const T_t &val); + inline TensorFieldMap & operator=(const T_t & val); //! Move assignment operator - TensorFieldMap &operator=(TensorFieldMap &&other) = delete; + TensorFieldMap & operator=(TensorFieldMap && other) = delete; //! give human-readable field map type inline std::string info_string() const final; //! member access inline reference operator[](size_type index); //! member access - inline reference operator[](const Ccoord &ccoord); + inline reference operator[](const Ccoord & ccoord); //! member access inline const_reference operator[](size_type index) const; //! member access - inline const_reference operator[](const Ccoord &ccoord) const; + inline const_reference operator[](const Ccoord & ccoord) const; //! return an iterator to first entry of field inline iterator begin() { return iterator(*this); } //! return an iterator to first entry of field inline const_iterator cbegin() const { return const_iterator(*this); } //! return an iterator to first entry of field inline const_iterator begin() const { return this->cbegin(); } //! return an iterator past the last entry of field inline iterator end() { return iterator(*this, false); } //! return an iterator past the last entry of field inline const_iterator cend() const { return const_iterator(*this, false); } //! return an iterator past the last entry of field inline const_iterator end() const { return this->cend(); } /** * return an iterable proxy to this field that can be iterated * in Ccoord-value tuples */ enumerator enumerate() { return enumerator(*this); } /** * return an iterable proxy to this field that can be iterated * in Ccoord-value tuples */ const_enumerator enumerate() const { return const_enumerator(*this); } //! evaluate the average of the field inline T_t mean() const; protected: //! for sad, legacy iterator use inline pointer ptr_to_val_t(size_type index); private: }; /* ---------------------------------------------------------------------- */ template TensorFieldMap::TensorFieldMap( - Field_c &field) + Field_c & field) : Parent(field) { this->check_compatibility(); } /* ---------------------------------------------------------------------- */ //! human-readable field map type template std::string TensorFieldMap::info_string() const { std::stringstream info; info << "Tensor(" << typeid(T).name() << ", " << order << "_o, " << dim << "_d)"; return info.str(); } /* ---------------------------------------------------------------------- */ //! member access template typename TensorFieldMap::reference TensorFieldMap:: operator[](size_type index) { - auto &&lambda = [this, &index](auto &&... tens_sizes) { + auto && lambda = [this, &index](auto &&... tens_sizes) { return reference(this->get_ptr_to_entry(index), tens_sizes...); }; return call_sizes(lambda); } template typename TensorFieldMap::reference TensorFieldMap:: - operator[](const Ccoord &ccoord) { - auto &&index = this->collection.get_index(ccoord); - auto &&lambda = [this, &index](auto &&... sizes) { + operator[](const Ccoord & ccoord) { + auto && index = this->collection.get_index(ccoord); + auto && lambda = [this, &index](auto &&... sizes) { return reference(this->get_ptr_to_entry(index), sizes...); }; return call_sizes(lambda); } template typename TensorFieldMap::const_reference TensorFieldMap:: operator[](size_type index) const { // Warning: due to a inconsistency in Eigen's API, tensor maps // cannot be constructed from a const ptr, hence this nasty const // cast :( - auto &&lambda = [this, &index](auto &&... tens_sizes) { + auto && lambda = [this, &index](auto &&... tens_sizes) { return const_reference(const_cast(this->get_ptr_to_entry(index)), tens_sizes...); }; return call_sizes(lambda); } template typename TensorFieldMap::const_reference TensorFieldMap:: - operator[](const Ccoord &ccoord) const { - auto &&index = this->collection.get_index(ccoord); - auto &&lambda = [this, &index](auto &&... sizes) { + operator[](const Ccoord & ccoord) const { + auto && index = this->collection.get_index(ccoord); + auto && lambda = [this, &index](auto &&... sizes) { return const_reference(const_cast(this->get_ptr_to_entry(index)), sizes...); }; return call_sizes(lambda); } /* ---------------------------------------------------------------------- */ template TensorFieldMap & TensorFieldMap:: - operator=(const T_t &val) { - for (auto &&tens : *this) { + operator=(const T_t & val) { + for (auto && tens : *this) { tens = val; } return *this; } /* ---------------------------------------------------------------------- */ template typename TensorFieldMap::T_t TensorFieldMap::mean() const { T_t mean{T_t::Zero()}; - for (auto &&val : *this) { + for (auto && val : *this) { mean += val; } mean *= 1. / Real(this->size()); return mean; } /* ---------------------------------------------------------------------- */ //! for sad, legacy iterator use. Don't use unless you have to. template typename TensorFieldMap::pointer TensorFieldMap::ptr_to_val_t( size_type index) { - auto &&lambda = [this, &index](auto &&... tens_sizes) { + auto && lambda = [this, &index](auto &&... tens_sizes) { return std::make_unique(this->get_ptr_to_entry(index), tens_sizes...); }; return call_sizes(lambda); } } // namespace muSpectre #endif // SRC_COMMON_FIELD_MAP_TENSOR_HH_ diff --git a/src/common/field_typed.hh b/src/common/field_typed.hh index 1c82963..77f845d 100644 --- a/src/common/field_typed.hh +++ b/src/common/field_typed.hh @@ -1,531 +1,531 @@ /** * file field_typed.hh * * @author Till Junge * * @date 10 Apr 2018 * * @brief Typed Field for dynamically sized fields and base class for fields * of tensors, matrices, etc * * Copyright © 2018 Till Junge * * µSpectre 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, 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 Lesser General Public License * along with µSpectre; see the file COPYING. If not, write to the * Free Software Foundation, Inc., 59 Temple Place - Suite 330, * * Boston, MA 02111-1307, USA. * * Additional permission under GNU GPL version 3 section 7 * * If you modify this Program, or any covered work, by linking or combining it * with proprietary FFT implementations or numerical libraries, containing parts * covered by the terms of those libraries' licenses, the licensors of this * Program grant you additional permission to convey the resulting work. */ #ifndef SRC_COMMON_FIELD_TYPED_HH_ #define SRC_COMMON_FIELD_TYPED_HH_ #include "common/field_base.hh" #include "common/field_helpers.hh" #include namespace muSpectre { /** * forward-declaration */ template class TypedFieldMap; namespace internal { /* ---------------------------------------------------------------------- */ //! declaraton for friending template class FieldMap; } // namespace internal /** * Dummy intermediate class to provide a run-time polymorphic * typed field. Mainly for binding Python. TypedField specifies methods * that return typed Eigen maps and vectors in addition to pointers to the * raw data. */ template class TypedField : public internal::FieldBase { friend class internal::FieldMap; friend class internal::FieldMap; static constexpr bool Global{FieldCollection::is_global()}; public: using Parent = internal::FieldBase; //!< base class //! for type checks when mapping this field using collection_t = typename Parent::collection_t; //! for filling global fields from local fields and vice-versa using LocalField_t = std::conditional_t< Global, TypedField, TypedField>; //! for filling global fields from local fields and vice-versa using GlobalField_t = std::conditional_t< Global, TypedField, TypedField>; using Scalar = T; //!< for type checks using Base = Parent; //!< for uniformity of interface //! Plain Eigen type to map using EigenRep_t = Eigen::Array; using EigenVecRep_t = Eigen::Matrix; //! map returned when accessing entire field using EigenMap_t = Eigen::Map; //! map returned when accessing entire const field using EigenMapConst_t = Eigen::Map; //! Plain eigen vector to map using EigenVec_t = Eigen::Map; //! vector map returned when accessing entire field using EigenVecConst_t = Eigen::Map; //! associated non-const field map using FieldMap_t = TypedFieldMap; //! associated const field map using ConstFieldMap_t = TypedFieldMap; /** * type stored (unfortunately, we can't statically size the second * dimension due to an Eigen bug, i.e., creating a row vector * reference to a column vector does not raise an error :( */ using Stored_t = Eigen::Array; //! storage container using Storage_t = std::vector>; //! Default constructor TypedField() = delete; //! constructor - TypedField(std::string unique_name, FieldCollection &collection, + TypedField(std::string unique_name, FieldCollection & collection, size_t nb_components); /** * constructor for field proxies which piggy-back on existing * memory. These cannot be registered in field collections and * should only be used for transient temporaries */ - TypedField(std::string unique_name, FieldCollection &collection, + TypedField(std::string unique_name, FieldCollection & collection, Eigen::Ref> vec, size_t nb_components); //! Copy constructor - TypedField(const TypedField &other) = delete; + TypedField(const TypedField & other) = delete; //! Move constructor - TypedField(TypedField &&other) = default; + TypedField(TypedField && other) = default; //! Destructor virtual ~TypedField() = default; //! Copy assignment operator - TypedField &operator=(const TypedField &other) = delete; + TypedField & operator=(const TypedField & other) = delete; //! Move assignment operator - TypedField &operator=(TypedField &&other) = delete; + TypedField & operator=(TypedField && other) = delete; //! return type_id of stored type - const std::type_info &get_stored_typeid() const final; + const std::type_info & get_stored_typeid() const final; //! safe reference cast - static TypedField &check_ref(Base &other); + static TypedField & check_ref(Base & other); //! safe reference cast - static const TypedField &check_ref(const Base &other); + static const TypedField & check_ref(const Base & other); size_t size() const final; //! add a pad region to the end of the field buffer; required for //! using this as e.g. an FFT workspace void set_pad_size(size_t pad_size_) final; //! initialise field to zero (do more complicated initialisations through //! fully typed maps) void set_zero() final; //! add a new value at the end of the field template - inline void push_back(const Eigen::DenseBase &value); + inline void push_back(const Eigen::DenseBase & value); //! raw pointer to content (e.g., for Eigen maps) - virtual T *data() { return this->get_ptr_to_entry(0); } + virtual T * data() { return this->get_ptr_to_entry(0); } //! raw pointer to content (e.g., for Eigen maps) - virtual const T *data() const { return this->get_ptr_to_entry(0); } + virtual const T * data() const { return this->get_ptr_to_entry(0); } //! return a map representing the entire field as a single `Eigen::Array` EigenMap_t eigen(); //! return a map representing the entire field as a single `Eigen::Array` EigenMapConst_t eigen() const; //! return a map representing the entire field as a single Eigen vector EigenVec_t eigenvec(); //! return a map representing the entire field as a single Eigen vector EigenVecConst_t eigenvec() const; //! return a map representing the entire field as a single Eigen vector EigenVecConst_t const_eigenvec() const; /** * Convenience function to return a map onto this field. A map * allows iteration over all pixels. The map's iterator returns a * dynamically sized `Eigen::Map` the data associated with a * pixel. */ inline FieldMap_t get_map(); /** * Convenience function to return a map onto this field. A map * allows iteration over all pixels. The map's iterator returns a * dynamically sized `Eigen::Map` the data associated with a * pixel. */ inline ConstFieldMap_t get_map() const; /** * Convenience function to return a map onto this field. A map * allows iteration over all pixels. The map's iterator returns a * dynamically sized `Eigen::Map` the data associated with a * pixel. */ inline ConstFieldMap_t get_const_map() const; /** * creates a `TypedField` same size and type as this, but all * entries are zero. Convenience function */ - inline TypedField &get_zeros_like(std::string unique_name) const; + inline TypedField & get_zeros_like(std::string unique_name) const; /** * Fill the content of the local field into the global field * (obviously only for pixels that actually are present in the * local field) */ template inline std::enable_if_t - fill_from_local(const LocalField_t &local); + fill_from_local(const LocalField_t & local); /** * For pixels that are present in the local field, fill them with * the content of the global field at those pixels */ template inline std::enable_if_t - fill_from_global(const GlobalField_t &global); + fill_from_global(const GlobalField_t & global); protected: //! returns a raw pointer to the entry, for `Eigen::Map` - inline T *get_ptr_to_entry(const size_t &&index); + inline T * get_ptr_to_entry(const size_t && index); //! returns a raw pointer to the entry, for `Eigen::Map` - inline const T *get_ptr_to_entry(const size_t &&index) const; + inline const T * get_ptr_to_entry(const size_t && index) const; //! set the storage size of this field inline void resize(size_t size) final; //! The actual storage container Storage_t values{}; /** * an unregistered typed field can be mapped onto an array of * existing values */ optional>> alt_values{}; /** * maintains a tally of the current size, as it cannot be reliably * determined from either `values` or `alt_values` alone. */ size_t current_size; /** * in order to accomodate both registered fields (who own and * manage their data) and unregistered temporary field proxies * (piggy-backing on a chunk of existing memory as e.g., a numpy * array) *efficiently*, the `get_ptr_to_entry` methods need to be * branchless. this means that we cannot decide on the fly whether * to return pointers pointing into values or into alt_values, we * need to maintain an (shudder) raw data pointer that is set * either at construction (for unregistered fields) or at any * resize event (which may invalidate existing pointers). For the * coder, this means that they need to be absolutely vigilant that * *any* operation on the values vector that invalidates iterators * needs to be followed by an update of data_ptr, or we will get * super annoying memory bugs. */ - T *data_ptr{}; + T * data_ptr{}; private: }; } // namespace muSpectre #include "common/field_map_dynamic.hh" namespace muSpectre { /* ---------------------------------------------------------------------- */ /* Implementations */ /* ---------------------------------------------------------------------- */ template TypedField::TypedField(std::string unique_name, - FieldCollection &collection, + FieldCollection & collection, size_t nb_components) : Parent(unique_name, nb_components, collection), current_size{0} {} /* ---------------------------------------------------------------------- */ template TypedField::TypedField( - std::string unique_name, FieldCollection &collection, + std::string unique_name, FieldCollection & collection, Eigen::Ref> vec, size_t nb_components) : Parent(unique_name, nb_components, collection), alt_values{vec}, current_size{vec.size() / nb_components}, data_ptr{vec.data()} { if (vec.size() % nb_components) { std::stringstream err{}; err << "The vector you supplied has a size of " << vec.size() << ", which is not a multiple of the number of components (" << nb_components << ")"; throw FieldError(err.str()); } if (current_size != collection.size()) { std::stringstream err{}; err << "The vector you supplied has the size for " << current_size << " pixels with " << nb_components << "components each, but the " << "field collection has " << collection.size() << " pixels."; throw FieldError(err.str()); } } /* ---------------------------------------------------------------------- */ //! return type_id of stored type template const std::type_info & TypedField::get_stored_typeid() const { return typeid(T); } /* ---------------------------------------------------------------------- */ template auto TypedField::eigen() -> EigenMap_t { return EigenMap_t(this->data(), this->get_nb_components(), this->size()); } /* ---------------------------------------------------------------------- */ template auto TypedField::eigen() const -> EigenMapConst_t { return EigenMapConst_t(this->data(), this->get_nb_components(), this->size()); } /* ---------------------------------------------------------------------- */ template auto TypedField::eigenvec() -> EigenVec_t { return EigenVec_t(this->data(), this->get_nb_components() * this->size(), 1); } /* ---------------------------------------------------------------------- */ template auto TypedField::eigenvec() const -> EigenVecConst_t { return EigenVecConst_t(this->data(), this->get_nb_components() * this->size(), 1); } /* ---------------------------------------------------------------------- */ template auto TypedField::const_eigenvec() const -> EigenVecConst_t { return EigenVecConst_t(this->data(), this->get_nb_components() * this->size()); } /* ---------------------------------------------------------------------- */ template auto TypedField::get_map() -> FieldMap_t { return FieldMap_t(*this); } /* ---------------------------------------------------------------------- */ template auto TypedField::get_map() const -> ConstFieldMap_t { return ConstFieldMap_t(*this); } /* ---------------------------------------------------------------------- */ template auto TypedField::get_const_map() const -> ConstFieldMap_t { return ConstFieldMap_t(*this); } /* ---------------------------------------------------------------------- */ template auto TypedField::get_zeros_like(std::string unique_name) const -> TypedField & { return make_field(unique_name, this->collection, this->nb_components); } /* ---------------------------------------------------------------------- */ template template std::enable_if_t - TypedField::fill_from_local(const LocalField_t &local) { + TypedField::fill_from_local(const LocalField_t & local) { static_assert(IsGlobal == Global, "SFINAE parameter, do not touch"); if (not(local.get_nb_components() == this->get_nb_components())) { std::stringstream err_str{}; err_str << "Fields not compatible: You are trying to write a local " << local.get_nb_components() << "-component field into a global " << this->get_nb_components() << "-component field."; throw std::runtime_error(err_str.str()); } auto this_map{this->get_map()}; auto local_map{local.get_map()}; - for (const auto &&key_val : local_map.enumerate()) { - const auto &key{std::get<0>(key_val)}; - const auto &value{std::get<1>(key_val)}; + for (const auto && key_val : local_map.enumerate()) { + const auto & key{std::get<0>(key_val)}; + const auto & value{std::get<1>(key_val)}; this_map[key] = value; } } /* ---------------------------------------------------------------------- */ template template std::enable_if_t TypedField::fill_from_global( - const GlobalField_t &global) { + const GlobalField_t & global) { static_assert(IsLocal == not Global, "SFINAE parameter, do not touch"); if (not(global.get_nb_components() == this->get_nb_components())) { std::stringstream err_str{}; err_str << "Fields not compatible: You are trying to write a global " << global.get_nb_components() << "-component field into a local " << this->get_nb_components() << "-component field."; throw std::runtime_error(err_str.str()); } auto global_map{global.get_map()}; auto this_map{this->get_map()}; - for (auto &&key_val : this_map.enumerate()) { - const auto &key{std::get<0>(key_val)}; - auto &value{std::get<1>(key_val)}; + for (auto && key_val : this_map.enumerate()) { + const auto & key{std::get<0>(key_val)}; + auto & value{std::get<1>(key_val)}; value = global_map[key]; } } /* ---------------------------------------------------------------------- */ template void TypedField::resize(size_t size) { if (this->alt_values) { throw FieldError("Field proxies can't resize."); } this->current_size = size; this->values.resize(size * this->get_nb_components() + this->pad_size); this->data_ptr = &this->values.front(); } /* ---------------------------------------------------------------------- */ template void TypedField::set_zero() { std::fill(this->values.begin(), this->values.end(), T{}); } /* ---------------------------------------------------------------------- */ template - auto TypedField::check_ref(Base &other) -> TypedField & { + auto TypedField::check_ref(Base & other) -> TypedField & { if (typeid(T).hash_code() != other.get_stored_typeid().hash_code()) { std::string err = "Cannot create a Reference of requested type " + ("for field '" + other.get_name() + "' of type '" + other.get_stored_typeid().name() + "'"); throw std::runtime_error(err); } return static_cast(other); } /* ---------------------------------------------------------------------- */ template - auto TypedField::check_ref(const Base &other) + auto TypedField::check_ref(const Base & other) -> const TypedField & { if (typeid(T).hash_code() != other.get_stored_typeid().hash_code()) { std::string err = "Cannot create a Reference of requested type " + ("for field '" + other.get_name() + "' of type '" + other.get_stored_typeid().name() + "'"); throw std::runtime_error(err); } return static_cast(other); } /* ---------------------------------------------------------------------- */ template size_t TypedField::size() const { return this->current_size; } /* ---------------------------------------------------------------------- */ template void TypedField::set_pad_size(size_t pad_size) { if (this->alt_values) { throw FieldError("You can't set the pad size of a field proxy."); } this->pad_size = pad_size; this->resize(this->size()); this->data_ptr = &this->values.front(); } /* ---------------------------------------------------------------------- */ template - T *TypedField::get_ptr_to_entry(const size_t &&index) { + T * TypedField::get_ptr_to_entry(const size_t && index) { return this->data_ptr + this->get_nb_components() * std::move(index); } /* ---------------------------------------------------------------------- */ template - const T * - TypedField::get_ptr_to_entry(const size_t &&index) const { + const T * TypedField::get_ptr_to_entry( + const size_t && index) const { return this->data_ptr + this->get_nb_components() * std::move(index); } /* ---------------------------------------------------------------------- */ template template void TypedField::push_back( - const Eigen::DenseBase &value) { + const Eigen::DenseBase & value) { static_assert(not FieldCollection::Global, "You can only push_back data into local field collections"); if (value.cols() != 1) { std::stringstream err{}; err << "Expected a column vector, but received and array with " << value.cols() << " colums."; throw FieldError(err.str()); } if (value.rows() != static_cast(this->get_nb_components())) { std::stringstream err{}; err << "Expected a column vector of length " << this->get_nb_components() << ", but received one of length " << value.rows() << "."; throw FieldError(err.str()); } for (size_t i = 0; i < this->get_nb_components(); ++i) { this->values.push_back(value(i)); } ++this->current_size; this->data_ptr = &this->values.front(); } } // namespace muSpectre #endif // SRC_COMMON_FIELD_TYPED_HH_ diff --git a/src/common/iterators.hh b/src/common/iterators.hh index bef84cc..dc59ed1 100644 --- a/src/common/iterators.hh +++ b/src/common/iterators.hh @@ -1,358 +1,366 @@ /** * @file iterators.hh * * @author Nicolas Richart * * @date creation Wed Jul 19 2017 * * @brief iterator interfaces * * Copyright (©) 2010-2011 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 . * * Above block was left intact as in akantu. µSpectre exercises the * right to redistribute and modify the code below * */ /* -------------------------------------------------------------------------- */ #include #include /* -------------------------------------------------------------------------- */ #ifndef SRC_COMMON_ITERATORS_HH_ #define SRC_COMMON_ITERATORS_HH_ namespace akantu { namespace tuple { /* ------------------------------------------------------------------------ */ namespace details { //! static for loop - template struct Foreach { + template + struct Foreach { //! undocumented template - static inline bool not_equal(Tuple &&a, Tuple &&b) { + static inline bool not_equal(Tuple && a, Tuple && b) { if (std::get(std::forward(a)) == std::get(std::forward(b))) return false; return Foreach::not_equal(std::forward(a), std::forward(b)); } }; /* ---------------------------------------------------------------------- */ //! static comparison - template <> struct Foreach<0> { + template <> + struct Foreach<0> { //! undocumented template - static inline bool not_equal(Tuple &&a, Tuple &&b) { + static inline bool not_equal(Tuple && a, Tuple && b) { return std::get<0>(std::forward(a)) != std::get<0>(std::forward(b)); } }; //! eats up a bunch of arguments and returns them packed in a tuple template decltype(auto) make_tuple_no_decay(Ts &&... args) { return std::tuple(std::forward(args)...); } //! helper for static for loop template - void foreach_impl(F &&func, Tuple &&tuple, + void foreach_impl(F && func, Tuple && tuple, std::index_sequence &&) { (void)std::initializer_list{ (std::forward(func)(std::get(std::forward(tuple))), 0)...}; } //! detail template - decltype(auto) transform_impl(F &&func, Tuple &&tuple, + decltype(auto) transform_impl(F && func, Tuple && tuple, std::index_sequence &&) { return make_tuple_no_decay( std::forward(func)(std::get(std::forward(tuple)))...); } }; // namespace details /* ------------------------------------------------------------------------ */ //! detail - template bool are_not_equal(Tuple &&a, Tuple &&b) { + template + bool are_not_equal(Tuple && a, Tuple && b) { return details::Foreach>::value>:: not_equal(std::forward(a), std::forward(b)); } //! detail - template void foreach(F &&func, Tuple && tuple) { + template + void foreach_(F && func, Tuple && tuple) { return details::foreach_impl( std::forward(func), std::forward(tuple), std::make_index_sequence< std::tuple_size>::value>{}); } //! detail template - decltype(auto) transform(F &&func, Tuple &&tuple) { + decltype(auto) transform(F && func, Tuple && tuple) { return details::transform_impl( std::forward(func), std::forward(tuple), std::make_index_sequence< std::tuple_size>::value>{}); } } // namespace tuple /* -------------------------------------------------------------------------- */ namespace iterators { //! iterator for emulation of python zip - template class ZipIterator { + template + class ZipIterator { private: using tuple_t = std::tuple; public: //! undocumented - ZipIterator(tuple_t iterators) + explicit ZipIterator(tuple_t iterators) : iterators(std::move(iterators)) {} //! undocumented decltype(auto) operator*() { - return tuple::transform([](auto &&it) -> decltype(auto) { return *it; }, - iterators); + return tuple::transform( + [](auto && it) -> decltype(auto) { return *it; }, iterators); } //! undocumented - ZipIterator &operator++() { - tuple::foreach([](auto &&it) { ++it; }, iterators); + ZipIterator & operator++() { + tuple::foreach_([](auto && it) { ++it; }, iterators); return *this; } //! undocumented - bool operator==(const ZipIterator &other) const { + bool operator==(const ZipIterator & other) const { return not tuple::are_not_equal(iterators, other.iterators); } //! undocumented - bool operator!=(const ZipIterator &other) const { + bool operator!=(const ZipIterator & other) const { return tuple::are_not_equal(iterators, other.iterators); } private: tuple_t iterators; }; } // namespace iterators /* -------------------------------------------------------------------------- */ //! emulates python zip() template - decltype(auto) zip_iterator(std::tuple &&iterators_tuple) { + decltype(auto) zip_iterator(std::tuple && iterators_tuple) { auto zip = iterators::ZipIterator( std::forward(iterators_tuple)); return zip; } /* -------------------------------------------------------------------------- */ namespace containers { //! helper for the emulation of python zip - template class ZipContainer { + template + class ZipContainer { using containers_t = std::tuple; public: //! undocumented - ZipContainer(Containers &&... containers) + explicit ZipContainer(Containers &&... containers) : containers(std::forward(containers)...) {} //! undocumented decltype(auto) begin() const { return zip_iterator( - tuple::transform([](auto &&c) { return c.begin(); }, + tuple::transform([](auto && c) { return c.begin(); }, std::forward(containers))); } //! undocumented decltype(auto) end() const { return zip_iterator( - tuple::transform([](auto &&c) { return c.end(); }, + tuple::transform([](auto && c) { return c.end(); }, std::forward(containers))); } //! undocumented decltype(auto) begin() { return zip_iterator( - tuple::transform([](auto &&c) { return c.begin(); }, + tuple::transform([](auto && c) { return c.begin(); }, std::forward(containers))); } //! undocumented decltype(auto) end() { return zip_iterator( - tuple::transform([](auto &&c) { return c.end(); }, + tuple::transform([](auto && c) { return c.end(); }, std::forward(containers))); } private: containers_t containers; }; } // namespace containers /* -------------------------------------------------------------------------- */ /** * emulates python's zip() */ - template decltype(auto) zip(Containers &&... conts) { + template + decltype(auto) zip(Containers &&... conts) { return containers::ZipContainer( std::forward(conts)...); } /* -------------------------------------------------------------------------- */ /* Arange */ /* -------------------------------------------------------------------------- */ namespace iterators { /** * emulates python's range iterator */ - template class ArangeIterator { + template + class ArangeIterator { public: //! undocumented using value_type = T; //! undocumented using pointer = T *; //! undocumented using reference = T &; //! undocumented using iterator_category = std::input_iterator_tag; //! undocumented constexpr ArangeIterator(T value, T step) : value(value), step(step) {} //! undocumented constexpr ArangeIterator(const ArangeIterator &) = default; //! undocumented - constexpr ArangeIterator &operator++() { + constexpr ArangeIterator & operator++() { value += step; return *this; } //! undocumented - constexpr const T &operator*() const { return value; } + constexpr const T & operator*() const { return value; } //! undocumented - constexpr bool operator==(const ArangeIterator &other) const { + constexpr bool operator==(const ArangeIterator & other) const { return (value == other.value) and (step == other.step); } //! undocumented - constexpr bool operator!=(const ArangeIterator &other) const { + constexpr bool operator!=(const ArangeIterator & other) const { return not operator==(other); } private: T value{0}; const T step{1}; }; } // namespace iterators namespace containers { //! helper class to generate range iterators - template class ArangeContainer { + template + class ArangeContainer { public: //! undocumented using iterator = iterators::ArangeIterator; //! undocumented constexpr ArangeContainer(T start, T stop, T step = 1) : start(start), stop((stop - start) % step == 0 ? stop : start + (1 + (stop - start) / step) * step), step(step) {} //! undocumented - constexpr ArangeContainer(T stop) - : ArangeContainer(0, stop, 1) {} + constexpr ArangeContainer(T stop) : ArangeContainer(0, stop, 1) {} //! undocumented constexpr T operator[](size_t i) { T val = start + i * step; assert(val < stop && "i is out of range"); return val; } //! undocumented constexpr T size() { return (stop - start) / step; } //! undocumented constexpr iterator begin() { return iterator(start, step); } //! undocumented constexpr iterator end() { return iterator(stop, step); } private: const T start{0}, stop{0}, step{1}; }; } // namespace containers /** * emulates python's range() */ template >::value>> - inline decltype(auto) arange(const T &stop) { + inline decltype(auto) arange(const T & stop) { return containers::ArangeContainer(stop); } /** * emulates python's range() */ template >::value>> - inline constexpr decltype(auto) arange(const T1 &start, const T2 &stop) { + inline constexpr decltype(auto) arange(const T1 & start, const T2 & stop) { return containers::ArangeContainer>(start, stop); } /** * emulates python's range() */ template >::value>> - inline constexpr decltype(auto) arange(const T1 &start, const T2 &stop, - const T3 &step) { + inline constexpr decltype(auto) arange(const T1 & start, const T2 & stop, + const T3 & step) { return containers::ArangeContainer>( start, stop, step); } /* -------------------------------------------------------------------------- */ /** * emulates python's enumerate */ template - inline constexpr decltype(auto) enumerate(Container &&container, + inline constexpr decltype(auto) enumerate(Container && container, size_t start_ = 0) { auto stop = std::forward(container).size(); decltype(stop) start = start_; return zip(arange(start, stop), std::forward(container)); } } // namespace akantu #endif // SRC_COMMON_ITERATORS_HH_ diff --git a/src/common/statefield.hh b/src/common/statefield.hh index c6ff480..ef48163 100644 --- a/src/common/statefield.hh +++ b/src/common/statefield.hh @@ -1,654 +1,659 @@ /** * file statefield.hh * * @author Till Junge * * @date 28 Feb 2018 * * @brief A state field is an abstraction of a field that can hold * current, as well as a chosen number of previous values. This is * useful for instance for internal state variables in plastic laws, * where a current, new, or trial state is computed based on its * previous state, and at convergence, this new state gets cycled into * the old, the old into the old-1 etc. The state field abstraction * helps doing this safely (i.e. only const references to the old * states are available, while the current state can be assigned * to/modified), and efficiently (i.e., no need to copy values from * new to old, we just cycle the labels). This file implements the * state field as well as state maps using the Field, FieldCollection * and FieldMap abstractions of µSpectre * * Copyright © 2018 Till Junge * * µSpectre 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, 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 Lesser General Public License * along with µSpectre; see the file COPYING. If not, write to the * Free Software Foundation, Inc., 59 Temple Place - Suite 330, * * Boston, MA 02111-1307, USA. * * Additional permission under GNU GPL version 3 section 7 * * If you modify this Program, or any covered work, by linking or combining it * with proprietary FFT implementations or numerical libraries, containing parts * covered by the terms of those libraries' licenses, the licensors of this * Program grant you additional permission to convey the resulting work. */ #ifndef SRC_COMMON_STATEFIELD_HH_ #define SRC_COMMON_STATEFIELD_HH_ #include "common/field.hh" #include "common/field_helpers.hh" #include "common/utilities.hh" #include #include #include namespace muSpectre { /** * Forward-declaration */ - template class TypedField; + template + class TypedField; /** * Base class for state fields, useful for storing polymorphic references */ - template class StateFieldBase { + template + class StateFieldBase { public: //! get naming prefix - const std::string &get_prefix() const { return this->prefix; } + const std::string & get_prefix() const { return this->prefix; } //! get a ref to the `StateField` 's field collection - const FieldCollection &get_collection() const { return this->collection; } + const FieldCollection & get_collection() const { return this->collection; } virtual ~StateFieldBase() = default; /** * returns number of old states that are stored */ size_t get_nb_memory() const { return this->nb_memory; } //! return type_id of stored type - virtual const std::type_info &get_stored_typeid() const = 0; + virtual const std::type_info & get_stored_typeid() const = 0; /** * cycle the fields (current becomes old, old becomes older, * oldest becomes current) */ virtual void cycle() = 0; protected: //! constructor - StateFieldBase(std::string unique_prefix, const FieldCollection &collection, - size_t nb_memory = 1) + StateFieldBase(std::string unique_prefix, + const FieldCollection & collection, size_t nb_memory = 1) : prefix{unique_prefix}, nb_memory{nb_memory}, collection{collection} {} /** * the unique prefix is used as the first part of the unique name * of the subfields belonging to this state field */ std::string prefix; /** * number of old states to store, defaults to 1 */ const size_t nb_memory; //! reference to the collection this statefield belongs to - const FieldCollection &collection; + const FieldCollection & collection; }; /* ---------------------------------------------------------------------- */ template class TypedStateField : public StateFieldBase { public: //! Parent class using Parent = StateFieldBase; //! Typed field using TypedField_t = TypedField; //! returns a TypedField ref to the current value of this state field - virtual TypedField_t &get_current_field() = 0; + virtual TypedField_t & get_current_field() = 0; //! returns a const TypedField ref to an old value of this state field virtual const TypedField_t & get_old_field(size_t nb_steps_ago = 1) const = 0; //! return type_id of stored type - const std::type_info &get_stored_typeid() const final { + const std::type_info & get_stored_typeid() const final { return typeid(T); }; virtual ~TypedStateField() = default; protected: //! constructor - TypedStateField(const std::string &unique_prefix, - const FieldCollection &collection, size_t nb_memory) + TypedStateField(const std::string & unique_prefix, + const FieldCollection & collection, size_t nb_memory) : Parent{unique_prefix, collection, nb_memory} {} }; /* ---------------------------------------------------------------------- */ template class TypedSizedStateField : public TypedStateField { public: //! Parent class using Parent = TypedStateField; //! the current (historically accurate) ordering of the fields using index_t = std::array; //! get the current ordering of the fields - inline const index_t &get_indices() const { return this->indices; } + inline const index_t & get_indices() const { return this->indices; } //! destructor virtual ~TypedSizedStateField() = default; protected: //! constructor TypedSizedStateField(std::string unique_prefix, - const FieldCollection &collection, index_t indices) + const FieldCollection & collection, index_t indices) : Parent{unique_prefix, collection, nb_memory}, indices{indices} {}; index_t indices; ///< these are cycled through }; //! early declaration - template class StateFieldMap; + template + class StateFieldMap; namespace internal { template inline decltype(auto) build_fields_helper(std::string prefix, - typename Field::Base::collection_t &collection, + typename Field::Base::collection_t & collection, std::index_sequence) { auto get_field{[&prefix, &collection](size_t i) -> Field & { std::stringstream name_stream{}; name_stream << prefix << ", sub_field index " << i; return make_field(name_stream.str(), collection); }}; return std::tie(get_field(I)...); } /* ---------------------------------------------------------------------- */ template inline decltype(auto) build_indices(std::index_sequence) { return std::array{(size - I) % size...}; } } // namespace internal /** * A statefield is an abstraction around a Field that can hold a * current and `nb_memory` previous values. There are useful for * history variables, for instance. */ template class StateField : public TypedSizedStateField { public: //! the underlying field's collection type using FieldCollection_t = typename Field_t::Base::collection_t; //! base type for fields using Scalar = typename Field_t::Scalar; //! Base class for all state fields of same memory using Base = TypedSizedStateField; /** * storage of field refs (can't be a `std::array`, because arrays * of refs are explicitely forbidden */ using Fields_t = tuple_array; //! Typed field using TypedField_t = TypedField; //! Default constructor StateField() = delete; //! Copy constructor - StateField(const StateField &other) = delete; + StateField(const StateField & other) = delete; //! Move constructor - StateField(StateField &&other) = delete; + StateField(StateField && other) = delete; //! Destructor virtual ~StateField() = default; //! Copy assignment operator - StateField &operator=(const StateField &other) = delete; + StateField & operator=(const StateField & other) = delete; //! Move assignment operator - StateField &operator=(StateField &&other) = delete; + StateField & operator=(StateField && other) = delete; //! get (modifiable) current field - inline Field_t ¤t() { return this->fields[this->indices[0]]; } + inline Field_t & current() { return this->fields[this->indices[0]]; } //! get (constant) previous field - template inline const Field_t &old() { + template + inline const Field_t & old() { static_assert(nb_steps_ago <= nb_memory, "you can't go that far inte the past"); static_assert(nb_steps_ago > 0, "Did you mean to call current()?"); return this->fields[this->indices.at(nb_steps_ago)]; } //! returns a TypedField ref to the current value of this state field - TypedField_t &get_current_field() override final { return this->current(); } + TypedField_t & get_current_field() final { return this->current(); } //! returns a const TypedField ref to an old value of this state field - const TypedField_t & - get_old_field(size_t nb_steps_ago = 1) const final { + const TypedField_t & get_old_field(size_t nb_steps_ago = 1) const final { return this->fields[this->indices.at(nb_steps_ago)]; } //! factory function template - friend StateFieldType &make_statefield(const std::string &unique_prefix, - CollectionType &collection); + friend StateFieldType & make_statefield(const std::string & unique_prefix, + CollectionType & collection); //! returns a `StateField` reference if `other is a compatible state field - inline static StateField &check_ref(Base &other) { + inline static StateField & check_ref(Base & other) { // the following triggers and exception if the fields are incompatible Field_t::check_ref(other.fields[0]); return static_cast(other); } //! returns a const `StateField` reference if `other` is a compatible state //! field - inline static const StateField &check_ref(const Base &other) { + inline static const StateField & check_ref(const Base & other) { // the following triggers and exception if the fields are incompatible Field_t::check_ref(other.fields[0]); return static_cast(other); } //! get a ref to the `StateField` 's fields - Fields_t &get_fields() { return this->fields; } + Fields_t & get_fields() { return this->fields; } /** * Pure convenience functions to get a MatrixFieldMap of * appropriate dimensions mapped to this field. You can also * create other types of maps, as long as they have the right * fundamental type (T), the correct size (nbComponents), and * memory (nb_memory). */ inline decltype(auto) get_map() { using FieldMap = decltype(std::get<0>(this->fields).get_map()); return StateFieldMap(*this); } /** * Pure convenience functions to get a MatrixFieldMap of * appropriate dimensions mapped to this field. You can also * create other types of maps, as long as they have the right * fundamental type (T), the correct size (nbComponents), and * memory (nb_memory). */ inline decltype(auto) get_const_map() { using FieldMap = decltype(std::get<0>(this->fields).get_const_map()); return StateFieldMap(*this); } /** * cycle the fields (current becomes old, old becomes older, * oldest becomes current) */ inline void cycle() final { - for (auto &val : this->indices) { + for (auto & val : this->indices) { val = (val + 1) % (nb_memory + 1); } } protected: /** * Constructor. @param unique_prefix is used to create the names * of the fields that this abstraction creates in the background * @param collection is the field collection in which the * subfields will be stored */ - inline StateField(const std::string &unique_prefix, - FieldCollection_t &collection) + inline StateField(const std::string & unique_prefix, + FieldCollection_t & collection) : Base{unique_prefix, collection, internal::build_indices( std::make_index_sequence{})}, fields{internal::build_fields_helper( unique_prefix, collection, std::make_index_sequence{})} {} Fields_t fields; //!< container for the states private: }; namespace internal { template - inline decltype(auto) build_maps_helper(Fields &fields, + inline decltype(auto) build_maps_helper(Fields & fields, std::index_sequence) { return std::array{FieldMap(std::get(fields))...}; } } // namespace internal /* ---------------------------------------------------------------------- */ template - inline StateFieldType &make_statefield(const std::string &unique_prefix, - CollectionType &collection) { + inline StateFieldType & make_statefield(const std::string & unique_prefix, + CollectionType & collection) { std::unique_ptr ptr{ new StateFieldType(unique_prefix, collection)}; - auto &retref{*ptr}; + auto & retref{*ptr}; collection.register_statefield(std::move(ptr)); return retref; } /** * extends the StateField <-> Field equivalence to StateFieldMap <-> FieldMap */ - template class StateFieldMap { + template + class StateFieldMap { public: /** * iterates over all pixels in the `muSpectre::FieldCollection` and * dereferences to a proxy giving access to the appropriate iterates * of the underlying `FieldMap` type. */ class iterator; //! stl conformance using reference = typename iterator::reference; //! stl conformance using value_type = typename iterator::value_type; //! stl conformance using size_type = typename iterator::size_type; //! field collection type where this state field can be stored using FieldCollection_t = typename FieldMap::Field::collection_t; //! Fundamental type stored using Scalar = typename FieldMap::Scalar; //! base class (must be at least sized) using TypedSizedStateField_t = TypedSizedStateField; //! for traits access using FieldMap_t = FieldMap; //! for traits access using ConstFieldMap_t = typename FieldMap::ConstMap; //! Default constructor StateFieldMap() = delete; //! constructor using a StateField template - explicit StateFieldMap(StateField & statefield) + explicit StateFieldMap(StateField & statefield) : collection{statefield.get_collection()}, statefield{statefield}, maps{internal::build_maps_helper( statefield.get_fields(), std::make_index_sequence{})}, const_maps{ internal::build_maps_helper( statefield.get_fields(), std::make_index_sequence{})} { static_assert(std::is_base_of::value, "Not the right type of StateField ref"); } //! Copy constructor - StateFieldMap(const StateFieldMap &other) = delete; + StateFieldMap(const StateFieldMap & other) = delete; //! Move constructor - StateFieldMap(StateFieldMap &&other) = default; + StateFieldMap(StateFieldMap && other) = default; //! Destructor virtual ~StateFieldMap() = default; //! Copy assignment operator - StateFieldMap &operator=(const StateFieldMap &other) = delete; + StateFieldMap & operator=(const StateFieldMap & other) = delete; //! Move assignment operator - StateFieldMap &operator=(StateFieldMap &&other) = delete; + StateFieldMap & operator=(StateFieldMap && other) = delete; //! access the wrapper to a given pixel directly value_type operator[](size_type index) { return *iterator(*this, index); } /** * return a ref to the current field map. useful for instance for * initialisations of `StateField` instances */ - FieldMap ¤t() { + FieldMap & current() { return this->maps[this->statefield.get_indices()[0]]; } //! stl conformance iterator begin() { return iterator(*this, 0); } //! stl conformance iterator end() { return iterator(*this, this->collection.size()); } protected: - const FieldCollection_t &collection; //!< collection holding the field - TypedSizedStateField_t &statefield; //!< ref to the field itself + const FieldCollection_t & collection; //!< collection holding the field + TypedSizedStateField_t & statefield; //!< ref to the field itself std::array maps; //!< refs to the addressable maps; //! const refs to the addressable maps; std::array const_maps; private: }; /** * Iterator class used by the `StateFieldMap` */ template class StateFieldMap::iterator { public: class StateWrapper; using Ccoord = typename FieldMap::Ccoord; //!< cell coordinates type using value_type = StateWrapper; //!< stl conformance using const_value_type = value_type; //!< stl conformance using pointer_type = value_type *; //!< stl conformance using difference_type = std::ptrdiff_t; //!< stl conformance using size_type = size_t; //!< stl conformance using iterator_category = std::random_access_iterator_tag; //!< stl conformance using reference = StateWrapper; //!< stl conformance //! Default constructor iterator() = delete; //! constructor - iterator(StateFieldMap &map, size_t index = 0) : index{index}, map{map} {}; + iterator(StateFieldMap & map, size_t index = 0) : index{index}, map{map} {}; //! Copy constructor - iterator(const iterator &other) = default; + iterator(const iterator & other) = default; //! Move constructor - iterator(iterator &&other) = default; + iterator(iterator && other) = default; //! Destructor virtual ~iterator() = default; //! Copy assignment operator - iterator &operator=(const iterator &other) = default; + iterator & operator=(const iterator & other) = default; //! Move assignment operator - iterator &operator=(iterator &&other) = default; + iterator & operator=(iterator && other) = default; //! pre-increment - inline iterator &operator++() { + inline iterator & operator++() { this->index++; return *this; } //! post-increment inline iterator operator++(int) { iterator curr{*this}; this->index++; return curr; } //! dereference inline value_type operator*() { return value_type(*this); } //! pre-decrement - inline iterator &operator--() { + inline iterator & operator--() { this->index--; return *this; } //! post-decrement inline iterator operator--(int) { iterator curr{*this}; this->index--; return curr; } //! access subscripting inline value_type operator[](difference_type diff) { return value_type{iterator{this->map, this->index + diff}}; } //! equality - inline bool operator==(const iterator &other) const { + inline bool operator==(const iterator & other) const { return this->index == other.index; } //! inequality - inline bool operator!=(const iterator &other) const { + inline bool operator!=(const iterator & other) const { return this->index != other.index; } //! div. comparisons - inline bool operator<(const iterator &other) const { + inline bool operator<(const iterator & other) const { return this->index < other.index; } //! div. comparisons - inline bool operator<=(const iterator &other) const { + inline bool operator<=(const iterator & other) const { return this->index <= other.index; } //! div. comparisons - inline bool operator>(const iterator &other) const { + inline bool operator>(const iterator & other) const { return this->index > other.index; } //! div. comparisons - inline bool operator>=(const iterator &other) const { + inline bool operator>=(const iterator & other) const { return this->index >= other.index; } //! additions, subtractions and corresponding assignments inline iterator operator+(difference_type diff) const { return iterator{this->map, this - index + diff}; } //! additions, subtractions and corresponding assignments inline iterator operator-(difference_type diff) const { return iterator{this->map, this - index - diff}; } //! additions, subtractions and corresponding assignments - inline iterator &operator+=(difference_type diff) { + inline iterator & operator+=(difference_type diff) { this->index += diff; return *this; } //! additions, subtractions and corresponding assignments - inline iterator &operator-=(difference_type diff) { + inline iterator & operator-=(difference_type diff) { this->index -= diff; return *this; } //! get pixel coordinates inline Ccoord get_ccoord() const { return this->map.collection.get_ccoord(this->index); } //! access the index - inline const size_t &get_index() const { return this->index; } + inline const size_t & get_index() const { return this->index; } protected: - size_t index; //!< current pixel this iterator refers to - StateFieldMap ↦ //!< map over with `this` iterates + size_t index; //!< current pixel this iterator refers to + StateFieldMap & map; //!< map over with `this` iterates private: }; namespace internal { //! FieldMap is an `Eigen::Map` or `Eigen::TensorMap` here template - inline decltype(auto) build_old_vals_helper(iterator &it, maps_t &maps, - indices_t &indices, + inline decltype(auto) build_old_vals_helper(iterator & it, maps_t & maps, + indices_t & indices, std::index_sequence) { return tuple_array( std::forward_as_tuple(maps[indices[I + 1]][it.get_index()]...)); } template - inline decltype(auto) build_old_vals(iterator &it, maps_t &maps, - indices_t &indices) { + inline decltype(auto) build_old_vals(iterator & it, maps_t & maps, + indices_t & indices) { return tuple_array{build_old_vals_helper( it, maps, indices, std::make_index_sequence{})}; } } // namespace internal /** * Light-weight resource-handle representing the current and old * values of a field at a given pixel identified by an iterator * pointing to it */ template class StateFieldMap::iterator::StateWrapper { public: //! short-hand using iterator = typename StateFieldMap::iterator; //! short-hand using Ccoord = typename iterator::Ccoord; //! short-hand using Map = typename FieldMap::reference; //! short-hand using ConstMap = typename FieldMap::const_reference; //! Default constructor StateWrapper() = delete; //! Copy constructor - StateWrapper(const StateWrapper &other) = default; + StateWrapper(const StateWrapper & other) = default; //! Move constructor - StateWrapper(StateWrapper &&other) = default; + StateWrapper(StateWrapper && other) = default; //! construct with `StateFieldMap::iterator` - StateWrapper(iterator &it) + StateWrapper(iterator & it) : it{it}, current_val{ it.map.maps[it.map.statefield.get_indices()[0]][it.index]}, old_vals(internal::build_old_vals( it, it.map.const_maps, it.map.statefield.get_indices())) {} //! Destructor virtual ~StateWrapper() = default; //! Copy assignment operator - StateWrapper &operator=(const StateWrapper &other) = default; + StateWrapper & operator=(const StateWrapper & other) = default; //! Move assignment operator - StateWrapper &operator=(StateWrapper &&other) = default; + StateWrapper & operator=(StateWrapper && other) = default; //! returns reference to the currectly mapped value - inline Map ¤t() { return this->current_val; } + inline Map & current() { return this->current_val; } //! recurnts reference the the value that was current `nb_steps_ago` ago - template inline const ConstMap &old() const { + template + inline const ConstMap & old() const { static_assert(nb_steps_ago <= nb_memory, "You have not stored that time step"); static_assert(nb_steps_ago > 0, "Did you mean to access the current value? If so, use " "current()"); return std::get(this->old_vals); } //! read the coordinates of the current pixel inline Ccoord get_ccoord() const { return this->it.get_ccoord(); } protected: - iterator ⁢ //!< ref to the iterator that dereferences to `this` + iterator & it; //!< ref to the iterator that dereferences to `this` Map current_val; //!< current value tuple_array old_vals; //!< all stored old values private: }; } // namespace muSpectre #endif // SRC_COMMON_STATEFIELD_HH_ diff --git a/src/common/tensor_algebra.hh b/src/common/tensor_algebra.hh index 6682fc2..5d6db26 100644 --- a/src/common/tensor_algebra.hh +++ b/src/common/tensor_algebra.hh @@ -1,277 +1,287 @@ /** * @file tensor_algebra.hh * * @author Till Junge * * @date 05 Nov 2017 * * @brief collection of compile-time quantities and algrebraic functions for * tensor operations * * Copyright © 2017 Till Junge * * µSpectre 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, 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 Lesser General Public License * along with µSpectre; see the file COPYING. If not, write to the * Free Software Foundation, Inc., 59 Temple Place - Suite 330, * * Boston, MA 02111-1307, USA. * * Additional permission under GNU GPL version 3 section 7 * * If you modify this Program, or any covered work, by linking or combining it * with proprietary FFT implementations or numerical libraries, containing parts * covered by the terms of those libraries' licenses, the licensors of this * Program grant you additional permission to convey the resulting work. */ #ifndef SRC_COMMON_TENSOR_ALGEBRA_HH_ #define SRC_COMMON_TENSOR_ALGEBRA_HH_ #include "common/T4_map_proxy.hh" #include "common/common.hh" #include "common/eigen_tools.hh" #include #include #include namespace muSpectre { namespace Tensors { //! second-order tensor representation template using Tens2_t = Eigen::TensorFixedSize>; //! fourth-order tensor representation template using Tens4_t = Eigen::TensorFixedSize>; //----------------------------------------------------------------------------// //! compile-time second-order identity - template constexpr inline Tens2_t I2() { + template + constexpr inline Tens2_t I2() { Tens2_t T; using Mat_t = Eigen::Matrix; Eigen::Map(&T(0, 0)) = Mat_t::Identity(); return T; } /* ---------------------------------------------------------------------- */ //! Check whether a given expression represents a Tensor specified order - template struct is_tensor { + template + struct is_tensor { //! evaluated test constexpr static bool value = (std::is_convertible>::value || std::is_convertible>::value || std::is_convertible>::value); }; /* ---------------------------------------------------------------------- */ /** compile-time outer tensor product as defined by Curnier * R_ijkl = A_ij.B_klxx * 0123 01 23 */ template - constexpr inline decltype(auto) outer(T1 &&A, T2 &&B) { + constexpr inline decltype(auto) outer(T1 && A, T2 && B) { // Just make sure that the right type of parameters have been given constexpr Dim_t order{2}; static_assert(is_tensor::value, "T1 needs to be convertible to a second order Tensor"); static_assert(is_tensor::value, "T2 needs to be convertible to a second order Tensor"); // actual function std::array, 0> dims{}; return A.contract(B, dims); } /* ---------------------------------------------------------------------- */ /** compile-time underlined outer tensor product as defined by Curnier * R_ijkl = A_ik.B_jlxx * 0123 02 13 * 0213 01 23 <- this defines the shuffle order */ template - constexpr inline decltype(auto) outer_under(T1 &&A, T2 &&B) { + constexpr inline decltype(auto) outer_under(T1 && A, T2 && B) { constexpr size_t order{4}; return outer(A, B).shuffle(std::array{{0, 2, 1, 3}}); } /* ---------------------------------------------------------------------- */ /** compile-time overlined outer tensor product as defined by Curnier * R_ijkl = A_il.B_jkxx * 0123 03 12 * 0231 01 23 <- this defines the shuffle order */ template - constexpr inline decltype(auto) outer_over(T1 &&A, T2 &&B) { + constexpr inline decltype(auto) outer_over(T1 && A, T2 && B) { constexpr size_t order{4}; return outer(A, B).shuffle(std::array{{0, 2, 3, 1}}); } //! compile-time fourth-order symmetrising identity - template constexpr inline Tens4_t I4S() { + template + constexpr inline Tens4_t I4S() { auto I = I2(); return 0.5 * (outer_under(I, I) + outer_over(I, I)); } } // namespace Tensors namespace Matrices { //! second-order tensor representation - template using Tens2_t = Eigen::Matrix; + template + using Tens2_t = Eigen::Matrix; //! fourth-order tensor representation - template using Tens4_t = T4Mat; + template + using Tens4_t = T4Mat; //----------------------------------------------------------------------------// //! compile-time second-order identity - template constexpr inline Tens2_t I2() { + template + constexpr inline Tens2_t I2() { return Tens2_t::Identity(); } /* ---------------------------------------------------------------------- */ /** compile-time outer tensor product as defined by Curnier * R_ijkl = A_ij.B_klxx * 0123 01 23 */ template - constexpr inline decltype(auto) outer(T1 &&A, T2 &&B) { + constexpr inline decltype(auto) outer(T1 && A, T2 && B) { // Just make sure that the right type of parameters have been given constexpr Dim_t dim{EigenCheck::tensor_dim::value}; static_assert((dim == EigenCheck::tensor_dim::value), "A and B do not have the same dimension"); Tens4_t product; for (Dim_t i = 0; i < dim; ++i) { for (Dim_t j = 0; j < dim; ++j) { for (Dim_t k = 0; k < dim; ++k) { for (Dim_t l = 0; l < dim; ++l) { get(product, i, j, k, l) = A(i, j) * B(k, l); } } } } return product; } /* ---------------------------------------------------------------------- */ /** compile-time underlined outer tensor product as defined by Curnier * R_ijkl = A_ik.B_jlxx * 0123 02 13 * 0213 01 23 <- this defines the shuffle order */ template - constexpr inline decltype(auto) outer_under(T1 &&A, T2 &&B) { + constexpr inline decltype(auto) outer_under(T1 && A, T2 && B) { // Just make sure that the right type of parameters have been given constexpr Dim_t dim{EigenCheck::tensor_dim::value}; static_assert((dim == EigenCheck::tensor_dim::value), "A and B do not have the same dimension"); Tens4_t product; for (Dim_t i = 0; i < dim; ++i) { for (Dim_t j = 0; j < dim; ++j) { for (Dim_t k = 0; k < dim; ++k) { for (Dim_t l = 0; l < dim; ++l) { get(product, i, j, k, l) = A(i, k) * B(j, l); } } } } return product; } /* ---------------------------------------------------------------------- */ /** compile-time overlined outer tensor product as defined by Curnier * R_ijkl = A_il.B_jkxx * 0123 03 12 * 0231 01 23 <- this defines the shuffle order */ template - constexpr inline decltype(auto) outer_over(T1 &&A, T2 &&B) { + constexpr inline decltype(auto) outer_over(T1 && A, T2 && B) { // Just make sure that the right type of parameters have been given constexpr Dim_t dim{EigenCheck::tensor_dim::value}; static_assert((dim == EigenCheck::tensor_dim::value), "A and B do not have the same dimension"); Tens4_t product; for (Dim_t i = 0; i < dim; ++i) { for (Dim_t j = 0; j < dim; ++j) { for (Dim_t k = 0; k < dim; ++k) { for (Dim_t l = 0; l < dim; ++l) { get(product, i, j, k, l) = A(i, l) * B(j, k); } } } } return product; } /** * Standart tensor multiplication */ template - constexpr inline decltype(auto) tensmult(const Eigen::MatrixBase &A, - const Eigen::MatrixBase &B) { + constexpr inline decltype(auto) tensmult(const Eigen::MatrixBase & A, + const Eigen::MatrixBase & B) { constexpr Dim_t dim{T2::RowsAtCompileTime}; static_assert(dim == T2::ColsAtCompileTime, "B is not square"); static_assert(dim != Eigen::Dynamic, "B not statically sized"); static_assert(dim * dim == T4::RowsAtCompileTime, "A and B not compatible"); static_assert(T4::RowsAtCompileTime == T4::ColsAtCompileTime, "A is not square"); Tens2_t result; result.setZero(); for (Dim_t i = 0; i < dim; ++i) { for (Dim_t j = 0; j < dim; ++j) { for (Dim_t k = 0; k < dim; ++k) { for (Dim_t l = 0; l < dim; ++l) { result(i, j) += get(A, i, j, k, l) * B(k, l); } } } } return result; } //! compile-time fourth-order tracer - template constexpr inline Tens4_t Itrac() { + template + constexpr inline Tens4_t Itrac() { auto I = I2(); return outer(I, I); } //! compile-time fourth-order identity - template constexpr inline Tens4_t Iiden() { + template + constexpr inline Tens4_t Iiden() { auto I = I2(); return outer_under(I, I); } //! compile-time fourth-order transposer - template constexpr inline Tens4_t Itrns() { + template + constexpr inline Tens4_t Itrns() { auto I = I2(); return outer_over(I, I); } //! compile-time fourth-order symmetriser - template constexpr inline Tens4_t Isymm() { + template + constexpr inline Tens4_t Isymm() { auto I = I2(); return 0.5 * (outer_under(I, I) + outer_over(I, I)); } } // namespace Matrices } // namespace muSpectre #endif // SRC_COMMON_TENSOR_ALGEBRA_HH_ diff --git a/src/common/utilities.hh b/src/common/utilities.hh index 16c83c6..ecad671 100644 --- a/src/common/utilities.hh +++ b/src/common/utilities.hh @@ -1,306 +1,310 @@ /** * @file utilities.hh * * @author Till Junge * * @date 17 Nov 2017 * * @brief additions to the standard name space to anticipate C++17 features * * Copyright © 2017 Till Junge * * µSpectre 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, 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 Lesser General Public License * along with µSpectre; see the file COPYING. If not, write to the * Free Software Foundation, Inc., 59 Temple Place - Suite 330, * * Boston, MA 02111-1307, USA. * * Additional permission under GNU GPL version 3 section 7 * * If you modify this Program, or any covered work, by linking or combining it * with proprietary FFT implementations or numerical libraries, containing parts * covered by the terms of those libraries' licenses, the licensors of this * Program grant you additional permission to convey the resulting work. */ #ifndef SRC_COMMON_UTILITIES_HH_ #define SRC_COMMON_UTILITIES_HH_ #include #ifdef NO_EXPERIMENTAL #include #else #include #endif namespace std_replacement { namespace detail { - template struct is_reference_wrapper : std::false_type {}; + template + struct is_reference_wrapper : std::false_type {}; template struct is_reference_wrapper> : std::true_type {}; //! from cppreference template - auto INVOKE(T Base::*pmf, Derived &&ref, Args &&... args) noexcept(noexcept( + auto + INVOKE(T Base::*pmf, Derived && ref, Args &&... args) noexcept(noexcept( (std::forward(ref).*pmf)(std::forward(args)...))) -> std::enable_if_t< std::is_function::value && std::is_base_of>::value, decltype((std::forward(ref).* pmf)(std::forward(args)...))> { return (std::forward(ref).*pmf)(std::forward(args)...); } //! from cppreference template - auto INVOKE(T Base::*pmf, RefWrap &&ref, Args &&... args) noexcept( + auto INVOKE(T Base::*pmf, RefWrap && ref, Args &&... args) noexcept( noexcept((ref.get().*pmf)(std::forward(args)...))) -> std::enable_if_t< std::is_function::value && is_reference_wrapper>::value, decltype((ref.get().*pmf)(std::forward(args)...))> { return (ref.get().*pmf)(std::forward(args)...); } //! from cppreference template - auto INVOKE(T Base::*pmf, Pointer &&ptr, Args &&... args) noexcept(noexcept( + auto + INVOKE(T Base::*pmf, Pointer && ptr, Args &&... args) noexcept(noexcept( ((*std::forward(ptr)).*pmf)(std::forward(args)...))) -> std::enable_if_t< std::is_function::value && !is_reference_wrapper>::value && !std::is_base_of>::value, decltype(((*std::forward(ptr)).* pmf)(std::forward(args)...))> { return ((*std::forward(ptr)).*pmf)(std::forward(args)...); } //! from cppreference template auto INVOKE(T Base::*pmd, - Derived &&ref) noexcept(noexcept(std::forward(ref).*pmd)) + Derived && ref) noexcept(noexcept(std::forward(ref).*pmd)) -> std::enable_if_t< !std::is_function::value && std::is_base_of>::value, decltype(std::forward(ref).*pmd)> { return std::forward(ref).*pmd; } //! from cppreference template - auto INVOKE(T Base::*pmd, RefWrap &&ref) noexcept(noexcept(ref.get().*pmd)) + auto INVOKE(T Base::*pmd, RefWrap && ref) noexcept(noexcept(ref.get().*pmd)) -> std::enable_if_t< !std::is_function::value && is_reference_wrapper>::value, decltype(ref.get().*pmd)> { return ref.get().*pmd; } //! from cppreference template - auto - INVOKE(T Base::*pmd, - Pointer &&ptr) noexcept(noexcept((*std::forward(ptr)).*pmd)) + auto INVOKE(T Base::*pmd, Pointer && ptr) noexcept( + noexcept((*std::forward(ptr)).*pmd)) -> std::enable_if_t< !std::is_function::value && !is_reference_wrapper>::value && !std::is_base_of>::value, decltype((*std::forward(ptr)).*pmd)> { return (*std::forward(ptr)).*pmd; } //! from cppreference template - auto INVOKE(F &&f, Args &&... args) noexcept( + auto INVOKE(F && f, Args &&... args) noexcept( noexcept(std::forward(f)(std::forward(args)...))) -> std::enable_if_t< !std::is_member_pointer>::value, decltype(std::forward(f)(std::forward(args)...))> { return std::forward(f)(std::forward(args)...); } } // namespace detail //! from cppreference template - auto invoke(F &&f, ArgTypes &&... args) + auto invoke(F && f, ArgTypes &&... args) // exception specification for QoI noexcept(noexcept(detail::INVOKE(std::forward(f), std::forward(args)...))) -> decltype(detail::INVOKE(std::forward(f), std::forward(args)...)) { return detail::INVOKE(std::forward(f), std::forward(args)...); } namespace detail { //! from cppreference template - constexpr decltype(auto) apply_impl(F &&f, Tuple &&t, + constexpr decltype(auto) apply_impl(F && f, Tuple && t, std::index_sequence) { return std_replacement::invoke(std::forward(f), std::get(std::forward(t))...); } } // namespace detail //! from cppreference template - constexpr decltype(auto) apply(F &&f, Tuple &&t) { + constexpr decltype(auto) apply(F && f, Tuple && t) { return detail::apply_impl( std::forward(f), std::forward(t), std::make_index_sequence< std::tuple_size>::value>{}); } } // namespace std_replacement namespace muSpectre { namespace internal { /** * helper struct template to compute the type of a tuple with a * given number of entries of the same type */ template struct tuple_array_helper { //! underlying tuple using type = typename tuple_array_helper::type; }; /** * helper struct template to compute the type of a tuple with a * given number of entries of the same type */ template struct tuple_array_helper<0, T, tail...> { //! underlying tuple using type = std::tuple; }; /** * helper struct for runtime index access to * tuples. RecursionLevel indicates how much more we can recurse * down */ template struct Accessor { using Stored_t = typename TupArr::Stored_t; - inline static Stored_t get(const size_t &index, TupArr &container) { + inline static Stored_t get(const size_t & index, TupArr & container) { if (index == Index) { return std::get(container); } else { return Accessor::get( index, container); } } - inline static const Stored_t get(const size_t &index, - const TupArr &container) { + inline static const Stored_t get(const size_t & index, + const TupArr & container) { if (index == Index) { return std::get(container); } else { return Accessor::get( index, container); } } }; /** * specialisation for recursion end */ - template struct Accessor { + template + struct Accessor { using Stored_t = typename TupArr::Stored_t; - inline static Stored_t get(const size_t &index, TupArr &container) { + inline static Stored_t get(const size_t & index, TupArr & container) { if (index == Index) { return std::get(container); } else { std::stringstream err{}; err << "Index " << index << "is out of range."; throw std::runtime_error(err.str()); } } - inline static const Stored_t get(const size_t &index, - const TupArr &container) { + inline static const Stored_t get(const size_t & index, + const TupArr & container) { if (index == Index) { return std::get(container); } else { std::stringstream err{}; err << "Index " << index << "is out of range."; throw std::runtime_error(err.str()); } } }; /** * helper struct that provides the tuple_array. */ - template struct tuple_array_provider { + template + struct tuple_array_provider { //! tuple type that can be used (almost) like an `std::array` class type : public tuple_array_helper::type { public: //! short-hand using Parent = typename tuple_array_helper::type; using Stored_t = T; constexpr static size_t Size{size}; //! constructor - explicit inline type(Parent &&parent) : Parent{parent} {} + explicit inline type(Parent && parent) : Parent{parent} {} //! element access - T operator[](const size_t &index) { + T operator[](const size_t & index) { return Accessor::get(index, *this); } //! element access - const T operator[](const size_t &index) const { + const T operator[](const size_t & index) const { return Accessor::get(index, *this); } protected: }; }; } // namespace internal /** * This is a convenience structure to create a tuple of `nb_elem` * entries of type `T`. It is named tuple_array, because it is * somewhat similar to an `std::array`. The reason for * this structure is that the `std::array` is not allowed by the * standard to store references (8.3.2 References, paragraph 5: * "There shall be no references to references, no arrays of * references, and no pointers to references.") use this, if you * want to have a statically known number of references to store, * and you wish to do so efficiently. */ template using tuple_array = typename internal::tuple_array_provider::type; using std_replacement::apply; /** * emulation `std::optional` (a C++17 feature) */ template #ifdef NO_EXPERIMENTAL using optional = typename boost::optional; #else using optional = typename std::experimental::optional; #endif } // namespace muSpectre #endif // SRC_COMMON_UTILITIES_HH_ diff --git a/src/common/voigt_conversion.hh b/src/common/voigt_conversion.hh index 348ce59..0050e32 100644 --- a/src/common/voigt_conversion.hh +++ b/src/common/voigt_conversion.hh @@ -1,217 +1,220 @@ /** * @file voigt_conversion.hh * * @author Till Junge * * @date 02 May 2017 * * @brief utilities to transform vector notation arrays into voigt notation * arrays and vice-versa * * Copyright © 2017 Till Junge * * µSpectre 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, 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 Lesser General Public License * along with µSpectre; see the file COPYING. If not, write to the * Free Software Foundation, Inc., 59 Temple Place - Suite 330, * * Boston, MA 02111-1307, USA. * * Additional permission under GNU GPL version 3 section 7 * * If you modify this Program, or any covered work, by linking or combining it * with proprietary FFT implementations or numerical libraries, containing parts * covered by the terms of those libraries' licenses, the licensors of this * Program grant you additional permission to convey the resulting work. */ #ifndef SRC_COMMON_VOIGT_CONVERSION_HH_ #define SRC_COMMON_VOIGT_CONVERSION_HH_ #include "common/common.hh" #include #include #include namespace muSpectre { /** * implements a bunch of static functions to convert between full * and Voigt notation of tensors */ - template class VoigtConversion { + template + class VoigtConversion { public: VoigtConversion(); virtual ~VoigtConversion(); //! obtain a fourth order voigt matrix from a tensor template - inline static void fourth_to_voigt(const Tens4 &t, Voigt &v); + inline static void fourth_to_voigt(const Tens4 & t, Voigt & v); //! return a fourth order voigt matrix from a tensor template inline static Eigen::Matrix(dim), vsize(dim)> - fourth_to_voigt(const Tens4 &t); + fourth_to_voigt(const Tens4 & t); //! return a fourth order non-symmetric voigt matrix from a tensor template inline static Eigen::Matrix(dim), vsize(dim)> - fourth_to_2d(const Tens4 &t) { + fourth_to_2d(const Tens4 & t) { return fourth_to_voigt(t); } //! probably obsolete template - inline static void second_to_voigt(const Tens2 &t, Voigt &v); + inline static void second_to_voigt(const Tens2 & t, Voigt & v); //! probably obsolete template - inline static void gradient_to_voigt_strain(const Tens2 &F, Voigt &v); + inline static void gradient_to_voigt_strain(const Tens2 & F, Voigt & v); //! probably obsolete template - inline static void gradient_to_voigt_GreenLagrange_strain(const Tens2 &F, - Voigt &v); + inline static void gradient_to_voigt_GreenLagrange_strain(const Tens2 & F, + Voigt & v); //! probably obsolete template - inline static void stress_from_voigt(const Voigt &v, Tens2 &sigma); + inline static void stress_from_voigt(const Voigt & v, Tens2 & sigma); public: //! matrix of vector index I as function of tensor indices i,j static const Eigen::Matrix mat; //! matrix of vector index I as function of tensor indices i,j static const Eigen::Matrix sym_mat; //! array of matrix indices ij as function of vector index I static const Eigen::Matrix vec; //! factors to multiply the strain by for voigt notation static const Eigen::Matrix factors; }; //! voigt vector indices for non-symmetric tensors template <> const Eigen::Matrix VoigtConversion<1>::mat = (Eigen::Matrix() << 0).finished(); //! voigt vector indices for non-symmetric tensors template <> const Eigen::Matrix VoigtConversion<2>::mat = (Eigen::Matrix() << 0, 2, 3, 1).finished(); //! voigt vector indices for non-symmetric tensors template <> const Eigen::Matrix VoigtConversion<3>::mat = (Eigen::Matrix() << 0, 5, 4, 8, 1, 3, 7, 6, 2).finished(); //! voigt vector indices template <> const Eigen::Matrix VoigtConversion<1>::sym_mat = (Eigen::Matrix() << 0).finished(); //! voigt vector indices template <> const Eigen::Matrix VoigtConversion<2>::sym_mat = (Eigen::Matrix() << 0, 2, 2, 1).finished(); //! voigt vector indices template <> const Eigen::Matrix VoigtConversion<3>::sym_mat = (Eigen::Matrix() << 0, 5, 4, 5, 1, 3, 4, 3, 2).finished(); //! matrix indices from voigt vectors template <> const Eigen::Matrix VoigtConversion<1>::vec = (Eigen::Matrix() << 0, 0).finished(); //! matrix indices from voigt vectors template <> const Eigen::Matrix VoigtConversion<2>::vec = (Eigen::Matrix() << 0, 0, 1, 1, 0, 1, 1, 0).finished(); //! matrix indices from voigt vectors template <> const Eigen::Matrix VoigtConversion<3>::vec = (Eigen::Matrix() << 0, 0, 1, 1, 2, 2, 1, 2, 0, 2, 0, 1, 2, 1, 2, 0, 1, 0) .finished(); //! factors for shear components in voigt notation template <> const Eigen::Matrix VoigtConversion<1>::factors = (Eigen::Matrix() << 1).finished(); //! factors for shear components in voigt notation template <> const Eigen::Matrix VoigtConversion<2>::factors = (Eigen::Matrix() << 1, 1, 2).finished(); //! factors for shear components in voigt notation template <> const Eigen::Matrix VoigtConversion<3>::factors = (Eigen::Matrix() << 1, 1, 1, 2, 2, 2).finished(); //----------------------------------------------------------------------------// template template - inline void VoigtConversion::fourth_to_voigt(const Tens4 &t, Voigt &v) { + inline void VoigtConversion::fourth_to_voigt(const Tens4 & t, + Voigt & v) { // upper case indices for Voigt notation, lower case for standard tensorial for (Dim_t I = 0; I < vsize(dim); ++I) { - auto &&i = vec(I, 0); - auto &&j = vec(I, 1); + auto && i = vec(I, 0); + auto && j = vec(I, 1); for (Dim_t J = 0; J < vsize(dim); ++J) { - auto &&k = vec(J, 0); - auto &&l = vec(J, 1); + auto && k = vec(J, 0); + auto && l = vec(J, 1); v(I, J) = t(i, j, k, l); } } } //----------------------------------------------------------------------------// template template inline Eigen::Matrix(dim), vsize(dim)> - VoigtConversion::fourth_to_voigt(const Tens4 &t) { + VoigtConversion::fourth_to_voigt(const Tens4 & t) { using V_t = Eigen::Matrix(dim), vsize(dim)>; V_t temp; fourth_to_voigt(t, temp); return temp; } //----------------------------------------------------------------------------// template template - inline void VoigtConversion::second_to_voigt(const Tens2 &F, Voigt &v) { + inline void VoigtConversion::second_to_voigt(const Tens2 & F, + Voigt & v) { for (Dim_t I = 0; I < vsize(dim); ++I) { - auto &&i = vec(I, 0); - auto &&j = vec(I, 1); + auto && i = vec(I, 0); + auto && j = vec(I, 1); v(I) = F(i, j); } } //----------------------------------------------------------------------------// template template - inline void VoigtConversion::gradient_to_voigt_strain(const Tens2 &F, - Voigt &v) { + inline void VoigtConversion::gradient_to_voigt_strain(const Tens2 & F, + Voigt & v) { for (Dim_t I = 0; I < vsize(dim); ++I) { - auto &&i = vec(I, 0); - auto &&j = vec(I, 1); + auto && i = vec(I, 0); + auto && j = vec(I, 1); v(I) = (F(i, j) + F(j, i)) / 2 * factors(I); } } //----------------------------------------------------------------------------// template template inline void - VoigtConversion::gradient_to_voigt_GreenLagrange_strain(const Tens2 &F, - Voigt &v) { + VoigtConversion::gradient_to_voigt_GreenLagrange_strain(const Tens2 & F, + Voigt & v) { using mat = Eigen::Matrix; mat E = 0.5 * (F.transpose() * F - mat::Identity()); for (Dim_t I = 0; I < vsize(dim); ++I) { - auto &&i = vec(I, 0); - auto &&j = vec(I, 1); + auto && i = vec(I, 0); + auto && j = vec(I, 1); v(I) = E(i, j) * factors(I); } } } // namespace muSpectre #endif // SRC_COMMON_VOIGT_CONVERSION_HH_ diff --git a/src/fft/fft_engine_base.cc b/src/fft/fft_engine_base.cc index 0b13831..3db922e 100644 --- a/src/fft/fft_engine_base.cc +++ b/src/fft/fft_engine_base.cc @@ -1,70 +1,72 @@ /** * @file fft_engine_base.cc * * @author Till Junge * * @date 03 Dec 2017 * * @brief implementation for FFT engine base class * * Copyright © 2017 Till Junge * * µSpectre 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, 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 Lesser General Public License * along with µSpectre; see the file COPYING. If not, write to the * Free Software Foundation, Inc., 59 Temple Place - Suite 330, * * Boston, MA 02111-1307, USA. * * Additional permission under GNU GPL version 3 section 7 * * If you modify this Program, or any covered work, by linking or combining it * with proprietary FFT implementations or numerical libraries, containing parts * covered by the terms of those libraries' licenses, the licensors of this * Program grant you additional permission to convey the resulting work. */ #include "fft/fft_engine_base.hh" namespace muSpectre { /* ---------------------------------------------------------------------- */ template FFTEngineBase::FFTEngineBase(Ccoord resolutions, Dim_t nb_components, Communicator comm) : comm{comm}, subdomain_resolutions{resolutions}, subdomain_locations{}, fourier_resolutions{CcoordOps::get_hermitian_sizes(resolutions)}, fourier_locations{}, domain_resolutions{resolutions}, work{make_field("work space", work_space_container, nb_components)}, norm_factor{1. / CcoordOps::get_size(domain_resolutions)}, nb_components{nb_components} {} /* ---------------------------------------------------------------------- */ template void FFTEngineBase::initialise(FFT_PlanFlags /*plan_flags*/) { this->work_space_container.initialise(); } /* ---------------------------------------------------------------------- */ - template size_t FFTEngineBase::size() const { + template + size_t FFTEngineBase::size() const { return CcoordOps::get_size(this->subdomain_resolutions); } /* ---------------------------------------------------------------------- */ - template size_t FFTEngineBase::workspace_size() const { + template + size_t FFTEngineBase::workspace_size() const { return this->work_space_container.size(); } template class FFTEngineBase; template class FFTEngineBase; } // namespace muSpectre diff --git a/src/fft/fft_engine_base.hh b/src/fft/fft_engine_base.hh index e3dc588..4760f11 100644 --- a/src/fft/fft_engine_base.hh +++ b/src/fft/fft_engine_base.hh @@ -1,185 +1,186 @@ /** * @file fft_engine_base.hh * * @author Till Junge * * @date 01 Dec 2017 * * @brief Interface for FFT engines * * Copyright © 2017 Till Junge * * µSpectre 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, 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 Lesser General Public License * along with µSpectre; see the file COPYING. If not, write to the * Free Software Foundation, Inc., 59 Temple Place - Suite 330, * * Boston, MA 02111-1307, USA. * * Additional permission under GNU GPL version 3 section 7 * * If you modify this Program, or any covered work, by linking or combining it * with proprietary FFT implementations or numerical libraries, containing parts * covered by the terms of those libraries' licenses, the licensors of this * Program grant you additional permission to convey the resulting work. */ #ifndef SRC_FFT_FFT_ENGINE_BASE_HH_ #define SRC_FFT_FFT_ENGINE_BASE_HH_ #include "common/common.hh" #include "common/communicator.hh" #include "common/field_collection.hh" namespace muSpectre { /** * Virtual base class for FFT engines. To be implemented by all * FFT_engine implementations. */ - template class FFTEngineBase { + template + class FFTEngineBase { public: constexpr static Dim_t sdim{DimS}; //!< spatial dimension of the cell //! cell coordinates type using Ccoord = Ccoord_t; //! global FieldCollection using GFieldCollection_t = GlobalFieldCollection; //! local FieldCollection (for Fourier-space pixels) using LFieldCollection_t = LocalFieldCollection; //! Field type on which to apply the projection using Field_t = TypedField; /** * Field type holding a Fourier-space representation of a * real-valued second-order tensor field */ using Workspace_t = TypedField; /** * iterator over Fourier-space discretisation point */ using iterator = typename LFieldCollection_t::iterator; //! Default constructor FFTEngineBase() = delete; //! Constructor with cell resolutions FFTEngineBase(Ccoord resolutions, Dim_t nb_components, Communicator comm = Communicator()); //! Copy constructor - FFTEngineBase(const FFTEngineBase &other) = delete; + FFTEngineBase(const FFTEngineBase & other) = delete; //! Move constructor - FFTEngineBase(FFTEngineBase &&other) = default; + FFTEngineBase(FFTEngineBase && other) = default; //! Destructor virtual ~FFTEngineBase() = default; //! Copy assignment operator - FFTEngineBase &operator=(const FFTEngineBase &other) = delete; + FFTEngineBase & operator=(const FFTEngineBase & other) = delete; //! Move assignment operator - FFTEngineBase &operator=(FFTEngineBase &&other) = default; + FFTEngineBase & operator=(FFTEngineBase && other) = default; //! compute the plan, etc virtual void initialise(FFT_PlanFlags /*plan_flags*/); //! forward transform (dummy for interface) - virtual Workspace_t &fft(Field_t & /*field*/) = 0; + virtual Workspace_t & fft(Field_t & /*field*/) = 0; //! inverse transform (dummy for interface) virtual void ifft(Field_t & /*field*/) const = 0; /** * iterators over only those pixels that exist in frequency space * (i.e. about half of all pixels, see rfft) */ //! returns an iterator to the first pixel in Fourier space inline iterator begin() { return this->work_space_container.begin(); } //! returns an iterator past to the last pixel in Fourier space inline iterator end() { return this->work_space_container.end(); } //! nb of pixels (mostly for debugging) size_t size() const; //! nb of pixels in Fourier space size_t workspace_size() const; //! return the communicator object - const Communicator &get_communicator() const { return this->comm; } + const Communicator & get_communicator() const { return this->comm; } //! returns the process-local resolutions of the cell - const Ccoord &get_subdomain_resolutions() const { + const Ccoord & get_subdomain_resolutions() const { return this->subdomain_resolutions; } //! returns the process-local locations of the cell - const Ccoord &get_subdomain_locations() const { + const Ccoord & get_subdomain_locations() const { return this->subdomain_locations; } //! returns the process-local resolutions of the cell in Fourier space - const Ccoord &get_fourier_resolutions() const { + const Ccoord & get_fourier_resolutions() const { return this->fourier_resolutions; } //! returns the process-local locations of the cell in Fourier space - const Ccoord &get_fourier_locations() const { + const Ccoord & get_fourier_locations() const { return this->fourier_locations; } //! returns the resolutions of the cell - const Ccoord &get_domain_resolutions() const { + const Ccoord & get_domain_resolutions() const { return this->domain_resolutions; } //! only required for testing and debugging - LFieldCollection_t &get_field_collection() { + LFieldCollection_t & get_field_collection() { return this->work_space_container; } //! only required for testing and debugging - Workspace_t &get_work_space() { return this->work; } + Workspace_t & get_work_space() { return this->work; } //! factor by which to multiply projection before inverse transform (this is //! typically 1/nb_pixels for so-called unnormalized transforms (see, //! e.g. //! http://www.fftw.org/fftw3_doc/Multi_002dDimensional-DFTs-of-Real-Data.html#Multi_002dDimensional-DFTs-of-Real-Data //! or https://docs.scipy.org/doc/numpy-1.13.0/reference/routines.fft.html //! . Rather than scaling the inverse transform (which would cost one more //! loop), FFT engines provide this value so it can be used in the //! projection operator (where no additional loop is required) inline Real normalisation() const { return norm_factor; } //! return the number of components per pixel Dim_t get_nb_components() const { return nb_components; } protected: /** * Field collection in which to store fields associated with * Fourier-space points */ Communicator comm; //!< communicator LFieldCollection_t work_space_container{}; Ccoord subdomain_resolutions; //!< resolutions of the process-local //!< (subdomain) portion of the cell Ccoord subdomain_locations; // !< location of the process-local (subdomain) // portion of the cell Ccoord fourier_resolutions; //!< resolutions of the process-local (subdomain) //!< portion of the Fourier transformed data Ccoord fourier_locations; // !< location of the process-local (subdomain) // portion of the Fourier transformed data const Ccoord domain_resolutions; //!< resolutions of the full domain of the cell - Workspace_t &work; //!< field to store the Fourier transform of P + Workspace_t & work; //!< field to store the Fourier transform of P const Real norm_factor; //!< normalisation coefficient of fourier transform Dim_t nb_components; private: }; } // namespace muSpectre #endif // SRC_FFT_FFT_ENGINE_BASE_HH_ diff --git a/src/fft/fft_utils.hh b/src/fft/fft_utils.hh index 5edcbd3..6ddf14b 100644 --- a/src/fft/fft_utils.hh +++ b/src/fft/fft_utils.hh @@ -1,130 +1,131 @@ /** * @file fft_utils.hh * * @author Till Junge * * @date 06 Dec 2017 * * @brief collection of functions used in the context of spectral operations * * Copyright © 2017 Till Junge * * µSpectre 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, 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 Lesser General Public License * along with µSpectre; see the file COPYING. If not, write to the * Free Software Foundation, Inc., 59 Temple Place - Suite 330, * * Boston, MA 02111-1307, USA. * * Additional permission under GNU GPL version 3 section 7 * * If you modify this Program, or any covered work, by linking or combining it * with proprietary FFT implementations or numerical libraries, containing parts * covered by the terms of those libraries' licenses, the licensors of this * Program grant you additional permission to convey the resulting work. */ #ifndef SRC_FFT_FFT_UTILS_HH_ #define SRC_FFT_FFT_UTILS_HH_ #include "common/common.hh" #include #include #include namespace muSpectre { /** * compute fft frequencies (in time (or length) units of of sampling * periods), see numpy's fftfreq function for reference */ std::valarray fft_freqs(size_t nb_samples); /** * compute fft frequencies in correct length or time units. Here, * length refers to the total size of the domain over which the fft * is taken (for instance the length of an edge of an RVE) */ std::valarray fft_freqs(size_t nb_samples, Real length); /** * Get fft_freqs for a grid */ template inline std::array, dim> fft_freqs(Ccoord_t sizes, std::array lengths) { std::array, dim> retval{}; for (size_t i = 0; i < dim; ++i) { retval[i] = std::move(fft_freqs(sizes[i], lengths[i])); } return retval; } /** * simple class encapsulating the creation, and retrieval of * wave vectors */ - template class FFT_freqs { + template + class FFT_freqs { public: //! return type for wave vectors using Vector = Eigen::Matrix; //! Default constructor FFT_freqs() = delete; //! constructor with problem sizes FFT_freqs(Ccoord_t sizes, std::array lengths) : freqs{fft_freqs(sizes, lengths)} {} //! Copy constructor - FFT_freqs(const FFT_freqs &other) = delete; + FFT_freqs(const FFT_freqs & other) = delete; //! Move constructor - FFT_freqs(FFT_freqs &&other) = default; + FFT_freqs(FFT_freqs && other) = default; //! Destructor virtual ~FFT_freqs() = default; //! Copy assignment operator - FFT_freqs &operator=(const FFT_freqs &other) = delete; + FFT_freqs & operator=(const FFT_freqs & other) = delete; //! Move assignment operator - FFT_freqs &operator=(FFT_freqs &&other) = default; + FFT_freqs & operator=(FFT_freqs && other) = default; //! get unnormalised wave vector (in sampling units) inline Vector get_xi(const Ccoord_t ccoord) const; //! get normalised wave vector inline Vector get_unit_xi(const Ccoord_t ccoord) const { - auto &&xi = this->get_xi(std::move(ccoord)); + auto && xi = this->get_xi(std::move(ccoord)); return xi / xi.norm(); } protected: //! container for frequencies ordered by spatial dimension const std::array, dim> freqs; private: }; template typename FFT_freqs::Vector FFT_freqs::get_xi(const Ccoord_t ccoord) const { Vector retval{}; for (Dim_t i = 0; i < dim; ++i) { retval(i) = this->freqs[i][ccoord[i]]; } return retval; } } // namespace muSpectre #endif // SRC_FFT_FFT_UTILS_HH_ diff --git a/src/fft/fftw_engine.cc b/src/fft/fftw_engine.cc index 4fa332f..5fc5db0 100644 --- a/src/fft/fftw_engine.cc +++ b/src/fft/fftw_engine.cc @@ -1,155 +1,158 @@ /** * @file fftw_engine.cc * * @author Till Junge * * @date 03 Dec 2017 * * @brief implements the fftw engine * * Copyright © 2017 Till Junge * * µSpectre 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, 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 Lesser General Public License * along with µSpectre; see the file COPYING. If not, write to the * Free Software Foundation, Inc., 59 Temple Place - Suite 330, * * Boston, MA 02111-1307, USA. * * Additional permission under GNU GPL version 3 section 7 * * If you modify this Program, or any covered work, by linking or combining it * with proprietary FFT implementations or numerical libraries, containing parts * covered by the terms of those libraries' licenses, the licensors of this * Program grant you additional permission to convey the resulting work. */ #include "fft/fftw_engine.hh" #include "common/ccoord_operations.hh" namespace muSpectre { template FFTWEngine::FFTWEngine(Ccoord resolutions, Dim_t nb_components, Communicator comm) : Parent{resolutions, nb_components, comm} { - for (auto &&pixel : CcoordOps::Pixels(this->fourier_resolutions)) { + for (auto && pixel : CcoordOps::Pixels(this->fourier_resolutions)) { this->work_space_container.add_pixel(pixel); } } /* ---------------------------------------------------------------------- */ template void FFTWEngine::initialise(FFT_PlanFlags plan_flags) { if (this->initialised) { throw std::runtime_error("double initialisation, will leak memory"); } Parent::initialise(plan_flags); - const int &rank = Dim; + const int & rank = Dim; std::array narr; - const int *const n = &narr[0]; + const int * const n = &narr[0]; std::copy(this->subdomain_resolutions.begin(), this->subdomain_resolutions.end(), narr.begin()); int howmany = this->nb_components; // temporary buffer for plan size_t alloc_size = (CcoordOps::get_size(this->subdomain_resolutions) * howmany); - Real *r_work_space = fftw_alloc_real(alloc_size); - Real *in = r_work_space; - const int *const inembed = + Real * r_work_space = fftw_alloc_real(alloc_size); + Real * in = r_work_space; + const int * const inembed = nullptr; // nembed are tricky: they refer to physical layout int istride = howmany; int idist = 1; - fftw_complex *out = reinterpret_cast(this->work.data()); - const int *const onembed = nullptr; + fftw_complex * out = reinterpret_cast(this->work.data()); + const int * const onembed = nullptr; int ostride = howmany; int odist = idist; unsigned int flags; switch (plan_flags) { case FFT_PlanFlags::estimate: { flags = FFTW_ESTIMATE; break; } case FFT_PlanFlags::measure: { flags = FFTW_MEASURE; break; } case FFT_PlanFlags::patient: { flags = FFTW_PATIENT; break; } default: throw std::runtime_error("unknown planner flag type"); break; } this->plan_fft = fftw_plan_many_dft_r2c( rank, n, howmany, in, inembed, istride, idist, out, onembed, ostride, odist, FFTW_PRESERVE_INPUT | flags); if (this->plan_fft == nullptr) { throw std::runtime_error("Plan failed"); } - fftw_complex *i_in = reinterpret_cast(this->work.data()); - Real *i_out = r_work_space; + fftw_complex * i_in = reinterpret_cast(this->work.data()); + Real * i_out = r_work_space; this->plan_ifft = fftw_plan_many_dft_c2r(rank, n, howmany, i_in, inembed, istride, idist, i_out, onembed, ostride, odist, flags); if (this->plan_ifft == nullptr) { throw std::runtime_error("Plan failed"); } fftw_free(r_work_space); this->initialised = true; } /* ---------------------------------------------------------------------- */ - template FFTWEngine::~FFTWEngine() noexcept { + template + FFTWEngine::~FFTWEngine() noexcept { fftw_destroy_plan(this->plan_fft); fftw_destroy_plan(this->plan_ifft); // TODO(Till): We cannot run fftw_cleanup since subsequent FFTW calls will // fail but multiple FFT engines can be active at the same time. // fftw_cleanup(); } /* ---------------------------------------------------------------------- */ template - typename FFTWEngine::Workspace_t &FFTWEngine::fft(Field_t &field) { + typename FFTWEngine::Workspace_t & + FFTWEngine::fft(Field_t & field) { if (this->plan_fft == nullptr) { throw std::runtime_error("fft plan not initialised"); } if (field.size() != CcoordOps::get_size(this->subdomain_resolutions)) { throw std::runtime_error("size mismatch"); } fftw_execute_dft_r2c(this->plan_fft, field.data(), reinterpret_cast(this->work.data())); return this->work; } /* ---------------------------------------------------------------------- */ - template void FFTWEngine::ifft(Field_t &field) const { + template + void FFTWEngine::ifft(Field_t & field) const { if (this->plan_ifft == nullptr) { throw std::runtime_error("ifft plan not initialised"); } if (field.size() != CcoordOps::get_size(this->subdomain_resolutions)) { throw std::runtime_error("size mismatch"); } fftw_execute_dft_c2r(this->plan_ifft, reinterpret_cast(this->work.data()), field.data()); } template class FFTWEngine; template class FFTWEngine; } // namespace muSpectre diff --git a/src/fft/fftw_engine.hh b/src/fft/fftw_engine.hh index 232e9d9..91cb2b8 100644 --- a/src/fft/fftw_engine.hh +++ b/src/fft/fftw_engine.hh @@ -1,97 +1,98 @@ /** * @file fftw_engine.hh * * @author Till Junge * * @date 03 Dec 2017 * * @brief FFT engine using FFTW * * Copyright © 2017 Till Junge * * µSpectre 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, 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 Lesser General Public License * along with µSpectre; see the file COPYING. If not, write to the * Free Software Foundation, Inc., 59 Temple Place - Suite 330, * * Boston, MA 02111-1307, USA. * * Additional permission under GNU GPL version 3 section 7 * * If you modify this Program, or any covered work, by linking or combining it * with proprietary FFT implementations or numerical libraries, containing parts * covered by the terms of those libraries' licenses, the licensors of this * Program grant you additional permission to convey the resulting work. */ #ifndef SRC_FFT_FFTW_ENGINE_HH_ #define SRC_FFT_FFTW_ENGINE_HH_ #include "fft/fft_engine_base.hh" #include namespace muSpectre { /** * implements the `muSpectre::FftEngine_Base` interface using the * FFTW library */ - template class FFTWEngine : public FFTEngineBase { + template + class FFTWEngine : public FFTEngineBase { public: using Parent = FFTEngineBase; //!< base class using Ccoord = typename Parent::Ccoord; //!< cell coordinates type //! field for Fourier transform of second-order tensor using Workspace_t = typename Parent::Workspace_t; //! real-valued second-order tensor using Field_t = typename Parent::Field_t; //! Default constructor FFTWEngine() = delete; //! Constructor with cell resolutions FFTWEngine(Ccoord resolutions, Dim_t nb_components, Communicator comm = Communicator()); //! Copy constructor - FFTWEngine(const FFTWEngine &other) = delete; + FFTWEngine(const FFTWEngine & other) = delete; //! Move constructor - FFTWEngine(FFTWEngine &&other) = default; + FFTWEngine(FFTWEngine && other) = default; //! Destructor virtual ~FFTWEngine() noexcept; //! Copy assignment operator - FFTWEngine &operator=(const FFTWEngine &other) = delete; + FFTWEngine & operator=(const FFTWEngine & other) = delete; //! Move assignment operator - FFTWEngine &operator=(FFTWEngine &&other) = default; + FFTWEngine & operator=(FFTWEngine && other) = default; // compute the plan, etc void initialise(FFT_PlanFlags plan_flags) override; //! forward transform - Workspace_t &fft(Field_t &field) override; + Workspace_t & fft(Field_t & field) override; //! inverse transform - void ifft(Field_t &field) const override; + void ifft(Field_t & field) const override; protected: fftw_plan plan_fft{}; //!< holds the plan for forward fourier transform fftw_plan plan_ifft{}; //!< holds the plan for inverse fourier transform bool initialised{false}; //!< to prevent double initialisation private: }; } // namespace muSpectre #endif // SRC_FFT_FFTW_ENGINE_HH_ diff --git a/src/fft/fftwmpi_engine.cc b/src/fft/fftwmpi_engine.cc index 32c0883..b862339 100644 --- a/src/fft/fftwmpi_engine.cc +++ b/src/fft/fftwmpi_engine.cc @@ -1,233 +1,236 @@ /** * @file fftwmpi_engine.cc * * @author Lars Pastewka * * @date 06 Mar 2017 * * @brief implements the MPI-parallel fftw engine * * Copyright © 2017 Till Junge * * µSpectre 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, 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 Lesser General Public License * along with µSpectre; see the file COPYING. If not, write to the * Free Software Foundation, Inc., 59 Temple Place - Suite 330, * * Boston, MA 02111-1307, USA. * * Additional permission under GNU GPL version 3 section 7 * * If you modify this Program, or any covered work, by linking or combining it * with proprietary FFT implementations or numerical libraries, containing parts * covered by the terms of those libraries' licenses, the licensors of this * Program grant you additional permission to convey the resulting work. */ #include "fft/fftwmpi_engine.hh" #include "common/ccoord_operations.hh" namespace muSpectre { - template int FFTWMPIEngine::nb_engines{0}; + template + int FFTWMPIEngine::nb_engines{0}; template FFTWMPIEngine::FFTWMPIEngine(Ccoord resolutions, Dim_t nb_components, Communicator comm) : Parent{resolutions, nb_components, comm} { if (!this->nb_engines) fftw_mpi_init(); this->nb_engines++; std::array narr; std::copy(this->domain_resolutions.begin(), this->domain_resolutions.end(), narr.begin()); narr[Dim - 1] = this->domain_resolutions[Dim - 1] / 2 + 1; ptrdiff_t res_x, loc_x, res_y, loc_y; this->workspace_size = fftw_mpi_local_size_many_transposed( Dim, narr.data(), this->nb_components, FFTW_MPI_DEFAULT_BLOCK, FFTW_MPI_DEFAULT_BLOCK, this->comm.get_mpi_comm(), &res_x, &loc_x, &res_y, &loc_y); this->fourier_resolutions[1] = this->fourier_resolutions[0]; this->fourier_locations[1] = this->fourier_locations[0]; this->subdomain_resolutions[0] = res_x; this->subdomain_locations[0] = loc_x; this->fourier_resolutions[0] = res_y; this->fourier_locations[0] = loc_y; - for (auto &n : this->subdomain_resolutions) { + for (auto & n : this->subdomain_resolutions) { if (n == 0) { throw std::runtime_error("FFTW MPI planning returned zero resolution. " "You may need to run on fewer processes."); } } - for (auto &n : this->fourier_resolutions) { + for (auto & n : this->fourier_resolutions) { if (n == 0) { throw std::runtime_error("FFTW MPI planning returned zero Fourier " "resolution. You may need to run on fewer " "processes."); } } - for (auto &&pixel : + for (auto && pixel : std::conditional_t, CcoordOps::Pixels>( this->fourier_resolutions, this->fourier_locations)) { this->work_space_container.add_pixel(pixel); } } /* ---------------------------------------------------------------------- */ template void FFTWMPIEngine::initialise(FFT_PlanFlags plan_flags) { if (this->initialised) { throw std::runtime_error("double initialisation, will leak memory"); } // Initialize parent after local resolutions have been determined and // work space has been initialized Parent::initialise(plan_flags); this->real_workspace = fftw_alloc_real(2 * this->workspace_size); // We need to check whether the workspace provided by our field is large // enough. MPI parallel FFTW may request a workspace size larger than the // nominal size of the complex buffer. if (static_cast(this->work.size() * this->nb_components) < this->workspace_size) { this->work.set_pad_size(this->workspace_size - this->nb_components * this->work.size()); } unsigned int flags; switch (plan_flags) { case FFT_PlanFlags::estimate: { flags = FFTW_ESTIMATE; break; } case FFT_PlanFlags::measure: { flags = FFTW_MEASURE; break; } case FFT_PlanFlags::patient: { flags = FFTW_PATIENT; break; } default: throw std::runtime_error("unknown planner flag type"); break; } std::array narr; std::copy(this->domain_resolutions.begin(), this->domain_resolutions.end(), narr.begin()); - Real *in{this->real_workspace}; - fftw_complex *out{reinterpret_cast(this->work.data())}; + Real * in{this->real_workspace}; + fftw_complex * out{reinterpret_cast(this->work.data())}; this->plan_fft = fftw_mpi_plan_many_dft_r2c( Dim, narr.data(), this->nb_components, FFTW_MPI_DEFAULT_BLOCK, FFTW_MPI_DEFAULT_BLOCK, in, out, this->comm.get_mpi_comm(), FFTW_MPI_TRANSPOSED_OUT | flags); if (this->plan_fft == nullptr) { throw std::runtime_error("r2c plan failed"); } - fftw_complex *i_in = reinterpret_cast(this->work.data()); - Real *i_out = this->real_workspace; + fftw_complex * i_in = reinterpret_cast(this->work.data()); + Real * i_out = this->real_workspace; this->plan_ifft = fftw_mpi_plan_many_dft_c2r( Dim, narr.data(), this->nb_components, FFTW_MPI_DEFAULT_BLOCK, FFTW_MPI_DEFAULT_BLOCK, i_in, i_out, this->comm.get_mpi_comm(), FFTW_MPI_TRANSPOSED_IN | flags); if (this->plan_ifft == nullptr) { throw std::runtime_error("c2r plan failed"); } this->initialised = true; } /* ---------------------------------------------------------------------- */ - template FFTWMPIEngine::~FFTWMPIEngine() noexcept { + template + FFTWMPIEngine::~FFTWMPIEngine() noexcept { if (this->real_workspace != nullptr) fftw_free(this->real_workspace); if (this->plan_fft != nullptr) fftw_destroy_plan(this->plan_fft); if (this->plan_ifft != nullptr) fftw_destroy_plan(this->plan_ifft); // TODO(junge): We cannot run fftw_mpi_cleanup since also calls fftw_cleanup // and any running FFTWEngine will fail afterwards. // this->nb_engines--; // if (!this->nb_engines) fftw_mpi_cleanup(); } /* ---------------------------------------------------------------------- */ template typename FFTWMPIEngine::Workspace_t & - FFTWMPIEngine::fft(Field_t &field) { + FFTWMPIEngine::fft(Field_t & field) { if (this->plan_fft == nullptr) { throw std::runtime_error("fft plan not initialised"); } if (field.size() != CcoordOps::get_size(this->subdomain_resolutions)) { throw std::runtime_error("size mismatch"); } // Copy non-padded field to padded real_workspace. // Transposed output of M x N x L transform for >= 3 dimensions is padded // M x N x 2*(L/2+1). ptrdiff_t fstride = (this->nb_components * this->subdomain_resolutions[Dim - 1]); ptrdiff_t wstride = (this->nb_components * 2 * (this->subdomain_resolutions[Dim - 1] / 2 + 1)); ptrdiff_t n = field.size() / this->subdomain_resolutions[Dim - 1]; auto fdata = field.data(); auto wdata = this->real_workspace; for (int i = 0; i < n; i++) { std::copy(fdata, fdata + fstride, wdata); fdata += fstride; wdata += wstride; } // Compute FFT fftw_mpi_execute_dft_r2c( this->plan_fft, this->real_workspace, reinterpret_cast(this->work.data())); return this->work; } /* ---------------------------------------------------------------------- */ - template void FFTWMPIEngine::ifft(Field_t &field) const { + template + void FFTWMPIEngine::ifft(Field_t & field) const { if (this->plan_ifft == nullptr) { throw std::runtime_error("ifft plan not initialised"); } if (field.size() != CcoordOps::get_size(this->subdomain_resolutions)) { throw std::runtime_error("size mismatch"); } // Compute inverse FFT fftw_mpi_execute_dft_c2r( this->plan_ifft, reinterpret_cast(this->work.data()), this->real_workspace); // Copy non-padded field to padded real_workspace. // Transposed output of M x N x L transform for >= 3 dimensions is padded // M x N x 2*(L/2+1). ptrdiff_t fstride{this->nb_components * this->subdomain_resolutions[Dim - 1]}; ptrdiff_t wstride{this->nb_components * 2 * (this->subdomain_resolutions[Dim - 1] / 2 + 1)}; ptrdiff_t n(field.size() / this->subdomain_resolutions[Dim - 1]); auto fdata{field.data()}; auto wdata{this->real_workspace}; for (int i = 0; i < n; i++) { std::copy(wdata, wdata + fstride, fdata); fdata += fstride; wdata += wstride; } } template class FFTWMPIEngine; template class FFTWMPIEngine; } // namespace muSpectre diff --git a/src/fft/fftwmpi_engine.hh b/src/fft/fftwmpi_engine.hh index b53563b..14a2256 100644 --- a/src/fft/fftwmpi_engine.hh +++ b/src/fft/fftwmpi_engine.hh @@ -1,103 +1,104 @@ /** * @file fftwmpi_engine.hh * * @author Lars Pastewka * * @date 06 Mar 2017 * * @brief FFT engine using MPI-parallel FFTW * * Copyright © 2017 Till Junge * * µSpectre 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, 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 Lesser General Public License * along with µSpectre; see the file COPYING. If not, write to the * Free Software Foundation, Inc., 59 Temple Place - Suite 330, * * Boston, MA 02111-1307, USA. * * Additional permission under GNU GPL version 3 section 7 * * If you modify this Program, or any covered work, by linking or combining it * with proprietary FFT implementations or numerical libraries, containing parts * covered by the terms of those libraries' licenses, the licensors of this * Program grant you additional permission to convey the resulting work. */ #ifndef SRC_FFT_FFTWMPI_ENGINE_HH_ #define SRC_FFT_FFTWMPI_ENGINE_HH_ #include "fft/fft_engine_base.hh" #include namespace muSpectre { /** * implements the `muSpectre::FFTEngineBase` interface using the * FFTW library */ - template class FFTWMPIEngine : public FFTEngineBase { + template + class FFTWMPIEngine : public FFTEngineBase { public: using Parent = FFTEngineBase; //!< base class using Ccoord = typename Parent::Ccoord; //!< cell coordinates type //! field for Fourier transform of second-order tensor using Workspace_t = typename Parent::Workspace_t; //! real-valued second-order tensor using Field_t = typename Parent::Field_t; //! Default constructor FFTWMPIEngine() = delete; //! Constructor with system resolutions FFTWMPIEngine(Ccoord resolutions, Dim_t nb_components, Communicator comm = Communicator()); //! Copy constructor - FFTWMPIEngine(const FFTWMPIEngine &other) = delete; + FFTWMPIEngine(const FFTWMPIEngine & other) = delete; //! Move constructor - FFTWMPIEngine(FFTWMPIEngine &&other) = default; + FFTWMPIEngine(FFTWMPIEngine && other) = default; //! Destructor virtual ~FFTWMPIEngine() noexcept; //! Copy assignment operator - FFTWMPIEngine &operator=(const FFTWMPIEngine &other) = delete; + FFTWMPIEngine & operator=(const FFTWMPIEngine & other) = delete; //! Move assignment operator - FFTWMPIEngine &operator=(FFTWMPIEngine &&other) = default; + FFTWMPIEngine & operator=(FFTWMPIEngine && other) = default; // compute the plan, etc void initialise(FFT_PlanFlags plan_flags) override; //! forward transform - Workspace_t &fft(Field_t &field) override; + Workspace_t & fft(Field_t & field) override; //! inverse transform - void ifft(Field_t &field) const override; + void ifft(Field_t & field) const override; protected: static int nb_engines; //!< number of times this engine has been instatiated fftw_plan plan_fft{}; //!< holds the plan for forward fourier transform fftw_plan plan_ifft{}; //!< holds the plan for inverse fourier transform ptrdiff_t workspace_size{}; //!< size of workspace buffer returned by planner - Real *real_workspace{}; //!< temporary real workspace that is correctly + Real * real_workspace{}; //!< temporary real workspace that is correctly //!< padded bool initialised{false}; //!< to prevent double initialisation private: }; } // namespace muSpectre #endif // SRC_FFT_FFTWMPI_ENGINE_HH_ diff --git a/src/fft/pfft_engine.cc b/src/fft/pfft_engine.cc index 132acc1..47d5ba8 100644 --- a/src/fft/pfft_engine.cc +++ b/src/fft/pfft_engine.cc @@ -1,241 +1,244 @@ /** * @file pfft_engine.cc * * @author Lars Pastewka * * @date 06 Mar 2017 * * @brief implements the MPI-parallel pfft engine * * Copyright © 2017 Till Junge * * µSpectre 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, 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 Lesser General Public License * along with µSpectre; see the file COPYING. If not, write to the * Free Software Foundation, Inc., 59 Temple Place - Suite 330, * * Boston, MA 02111-1307, USA. * * Additional permission under GNU GPL version 3 section 7 * * If you modify this Program, or any covered work, by linking or combining it * with proprietary FFT implementations or numerical libraries, containing parts * covered by the terms of those libraries' licenses, the licensors of this * Program grant you additional permission to convey the resulting work. */ #include "fft/pfft_engine.hh" #include "common/ccoord_operations.hh" namespace muSpectre { - template int PFFTEngine::nb_engines{0}; + template + int PFFTEngine::nb_engines{0}; template PFFTEngine::PFFTEngine(Ccoord resolutions, Dim_t nb_components, Communicator comm) : Parent{resolutions, nb_components, comm}, mpi_comm{ comm.get_mpi_comm()} { if (!this->nb_engines) pfft_init(); this->nb_engines++; int size{comm.size()}; int dim_x{size}; int dim_y{1}; // Note: All TODOs below don't affect the function of the PFFT engine. It // presently uses slab decompositions, the TODOs are what needs to be done // to get stripe decomposition to work - but it does not work yet. Slab // vs stripe decomposition may have an impact on how the code scales. // TODO(pastewka): Enable this to enable 2d process mesh. This does not pass // tests. // if (DimS > 2) { if (false) { dim_y = static_cast(sqrt(size)); while ((size / dim_y) * dim_y != size) dim_y--; dim_x = size / dim_y; } // TODO(pastewka): Enable this to enable 2d process mesh. This does not pass // tests. if (DimS > 2) { if (false) { if (pfft_create_procmesh_2d(this->comm.get_mpi_comm(), dim_x, dim_y, &this->mpi_comm)) { throw std::runtime_error("Failed to create 2d PFFT process mesh."); } } std::array narr; std::copy(this->domain_resolutions.begin(), this->domain_resolutions.end(), narr.begin()); ptrdiff_t res[DimS], loc[DimS], fres[DimS], floc[DimS]; this->workspace_size = pfft_local_size_many_dft_r2c( DimS, narr.data(), narr.data(), narr.data(), this->nb_components, PFFT_DEFAULT_BLOCKS, PFFT_DEFAULT_BLOCKS, this->mpi_comm, PFFT_TRANSPOSED_OUT, res, loc, fres, floc); std::copy(res, res + DimS, this->subdomain_resolutions.begin()); std::copy(loc, loc + DimS, this->subdomain_locations.begin()); std::copy(fres, fres + DimS, this->fourier_resolutions.begin()); std::copy(floc, floc + DimS, this->fourier_locations.begin()); // TODO(pastewka): Enable this to enable 2d process mesh. This does not pass // tests. for (int i = 0; i < DimS-1; ++i) { for (int i = 0; i < 1; ++i) { std::swap(this->fourier_resolutions[i], this->fourier_resolutions[i + 1]); std::swap(this->fourier_locations[i], this->fourier_locations[i + 1]); } - for (auto &n : this->subdomain_resolutions) { + for (auto & n : this->subdomain_resolutions) { if (n == 0) { throw std::runtime_error("PFFT planning returned zero resolution. " "You may need to run on fewer processes."); } } - for (auto &n : this->fourier_resolutions) { + for (auto & n : this->fourier_resolutions) { if (n == 0) { throw std::runtime_error("PFFT planning returned zero Fourier " "resolution. You may need to run on fewer " "processes."); } } - for (auto &&pixel : + for (auto && pixel : std::conditional_t, // TODO(pastewka): This should be the correct order // of dimension for a 2d process mesh, but tests // don't pass. CcoordOps::Pixels CcoordOps::Pixels>( this->fourier_resolutions, this->fourier_locations)) { this->work_space_container.add_pixel(pixel); } } /* ---------------------------------------------------------------------- */ template void PFFTEngine::initialise(FFT_PlanFlags plan_flags) { if (this->initialised) { throw std::runtime_error("double initialisation, will leak memory"); } // Initialize parent after local resolutions have been determined and // work space has been initialized Parent::initialise(plan_flags); this->real_workspace = pfft_alloc_real(2 * this->workspace_size); // We need to check whether the workspace provided by our field is large // enough. PFFT may request a workspace size larger than the nominal size // of the complex buffer. if (static_cast(this->work.size() * this->nb_components) < this->workspace_size) { this->work.set_pad_size(this->workspace_size - this->nb_components * this->work.size()); } unsigned int flags; switch (plan_flags) { case FFT_PlanFlags::estimate: { flags = PFFT_ESTIMATE; break; } case FFT_PlanFlags::measure: { flags = PFFT_MEASURE; break; } case FFT_PlanFlags::patient: { flags = PFFT_PATIENT; break; } default: throw std::runtime_error("unknown planner flag type"); break; } std::array narr; std::copy(this->domain_resolutions.begin(), this->domain_resolutions.end(), narr.begin()); - Real *in{this->real_workspace}; - pfft_complex *out{reinterpret_cast(this->work.data())}; + Real * in{this->real_workspace}; + pfft_complex * out{reinterpret_cast(this->work.data())}; this->plan_fft = pfft_plan_many_dft_r2c( DimS, narr.data(), narr.data(), narr.data(), this->nb_components, PFFT_DEFAULT_BLOCKS, PFFT_DEFAULT_BLOCKS, in, out, this->mpi_comm, PFFT_FORWARD, PFFT_TRANSPOSED_OUT | flags); if (this->plan_fft == nullptr) { throw std::runtime_error("r2c plan failed"); } - pfft_complex *i_in{reinterpret_cast(this->work.data())}; - Real *i_out{this->real_workspace}; + pfft_complex * i_in{reinterpret_cast(this->work.data())}; + Real * i_out{this->real_workspace}; this->plan_ifft = pfft_plan_many_dft_c2r( DimS, narr.data(), narr.data(), narr.data(), this->nb_components, PFFT_DEFAULT_BLOCKS, PFFT_DEFAULT_BLOCKS, i_in, i_out, this->mpi_comm, PFFT_BACKWARD, PFFT_TRANSPOSED_IN | flags); if (this->plan_ifft == nullptr) { throw std::runtime_error("c2r plan failed"); } this->initialised = true; } /* ---------------------------------------------------------------------- */ - template PFFTEngine::~PFFTEngine() noexcept { + template + PFFTEngine::~PFFTEngine() noexcept { if (this->real_workspace != nullptr) pfft_free(this->real_workspace); if (this->plan_fft != nullptr) pfft_destroy_plan(this->plan_fft); if (this->plan_ifft != nullptr) pfft_destroy_plan(this->plan_ifft); if (this->mpi_comm != this->comm.get_mpi_comm()) { MPI_Comm_free(&this->mpi_comm); } // TODO(Till): We cannot run fftw_mpi_cleanup since also calls fftw_cleanup // and any running FFTWEngine will fail afterwards. // this->nb_engines--; // if (!this->nb_engines) pfft_cleanup(); } /* ---------------------------------------------------------------------- */ template typename PFFTEngine::Workspace_t & - PFFTEngine::fft(Field_t &field) { + PFFTEngine::fft(Field_t & field) { if (!this->plan_fft) { throw std::runtime_error("fft plan not allocated"); } if (field.size() != CcoordOps::get_size(this->subdomain_resolutions)) { throw std::runtime_error("size mismatch"); } // Copy field data to workspace buffer. This is necessary because workspace // buffer is larger than field buffer. std::copy(field.data(), field.data() + this->nb_components * field.size(), this->real_workspace); pfft_execute_dft_r2c(this->plan_fft, this->real_workspace, reinterpret_cast(this->work.data())); return this->work; } /* ---------------------------------------------------------------------- */ - template void PFFTEngine::ifft(Field_t &field) const { + template + void PFFTEngine::ifft(Field_t & field) const { if (!this->plan_ifft) { throw std::runtime_error("ifft plan not allocated"); } if (field.size() != CcoordOps::get_size(this->subdomain_resolutions)) { throw std::runtime_error("size mismatch"); } pfft_execute_dft_c2r(this->plan_ifft, reinterpret_cast(this->work.data()), this->real_workspace); std::copy(this->real_workspace, this->real_workspace + this->nb_components * field.size(), field.data()); } template class PFFTEngine; template class PFFTEngine; } // namespace muSpectre diff --git a/src/fft/pfft_engine.hh b/src/fft/pfft_engine.hh index af26ff2..d3fdc68 100644 --- a/src/fft/pfft_engine.hh +++ b/src/fft/pfft_engine.hh @@ -1,106 +1,107 @@ /** * @file pfft_engine.hh * * @author Lars Pastewka * * @date 06 Mar 2017 * * @brief FFT engine using MPI-parallel PFFT * * Copyright © 2017 Till Junge * * µSpectre 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, 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 Lesser General Public License * along with µSpectre; see the file COPYING. If not, write to the * Free Software Foundation, Inc., 59 Temple Place - Suite 330, * * Boston, MA 02111-1307, USA. * * Additional permission under GNU GPL version 3 section 7 * * If you modify this Program, or any covered work, by linking or combining it * with proprietary FFT implementations or numerical libraries, containing parts * covered by the terms of those libraries' licenses, the licensors of this * Program grant you additional permission to convey the resulting work. */ #ifndef SRC_FFT_PFFT_ENGINE_HH_ #define SRC_FFT_PFFT_ENGINE_HH_ #include "common/communicator.hh" #include "fft/fft_engine_base.hh" #include namespace muSpectre { /** * implements the `muSpectre::FFTEngineBase` interface using the * FFTW library */ - template class PFFTEngine : public FFTEngineBase { + template + class PFFTEngine : public FFTEngineBase { public: using Parent = FFTEngineBase; //!< base class using Ccoord = typename Parent::Ccoord; //!< cell coordinates type //! field for Fourier transform of second-order tensor using Workspace_t = typename Parent::Workspace_t; //! real-valued second-order tensor using Field_t = typename Parent::Field_t; //! Default constructor PFFTEngine() = delete; //! Constructor with system resolutions PFFTEngine(Ccoord resolutions, Dim_t nb_components, Communicator comm = Communicator()); //! Copy constructor - PFFTEngine(const PFFTEngine &other) = delete; + PFFTEngine(const PFFTEngine & other) = delete; //! Move constructor - PFFTEngine(PFFTEngine &&other) = default; + PFFTEngine(PFFTEngine && other) = default; //! Destructor virtual ~PFFTEngine() noexcept; //! Copy assignment operator - PFFTEngine &operator=(const PFFTEngine &other) = delete; + PFFTEngine & operator=(const PFFTEngine & other) = delete; //! Move assignment operator - PFFTEngine &operator=(PFFTEngine &&other) = default; + PFFTEngine & operator=(PFFTEngine && other) = default; // compute the plan, etc void initialise(FFT_PlanFlags plan_flags) override; //! forward transform - Workspace_t &fft(Field_t &field) override; + Workspace_t & fft(Field_t & field) override; //! inverse transform - void ifft(Field_t &field) const override; + void ifft(Field_t & field) const override; protected: MPI_Comm mpi_comm; //! < MPI communicator static int nb_engines; //!< number of times this engine has been instatiated pfft_plan plan_fft{}; //!< holds the plan for forward fourier transform pfft_plan plan_ifft{}; //!< holds the plan for inverse fourier transform ptrdiff_t workspace_size{}; //!< size of workspace buffer returned by planner - Real *real_workspace{}; //!< temporary real workspace that is correctly + Real * real_workspace{}; //!< temporary real workspace that is correctly //!< padded bool initialised{false}; //!< to prevent double initialisation private: }; } // namespace muSpectre #endif // SRC_FFT_PFFT_ENGINE_HH_ diff --git a/src/fft/projection_base.hh b/src/fft/projection_base.hh index 70d8c2a..70a0f3a 100644 --- a/src/fft/projection_base.hh +++ b/src/fft/projection_base.hh @@ -1,186 +1,188 @@ /** * @file projection_base.hh * * @author Till Junge * * @date 03 Dec 2017 * * @brief Base class for Projection operators * * Copyright © 2017 Till Junge * * µSpectre 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, 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 Lesser General Public License * along with µSpectre; see the file COPYING. If not, write to the * Free Software Foundation, Inc., 59 Temple Place - Suite 330, * * Boston, MA 02111-1307, USA. * * Additional permission under GNU GPL version 3 section 7 * * If you modify this Program, or any covered work, by linking or combining it * with proprietary FFT implementations or numerical libraries, containing parts * covered by the terms of those libraries' licenses, the licensors of this * Program grant you additional permission to convey the resulting work. */ #ifndef SRC_FFT_PROJECTION_BASE_HH_ #define SRC_FFT_PROJECTION_BASE_HH_ #include "common/common.hh" #include "common/field.hh" #include "common/field_collection.hh" #include "fft/fft_engine_base.hh" #include namespace muSpectre { /** * base class for projection related exceptions */ class ProjectionError : public std::runtime_error { public: //! constructor - explicit ProjectionError(const std::string &what) + explicit ProjectionError(const std::string & what) : std::runtime_error(what) {} //! constructor - explicit ProjectionError(const char *what) : std::runtime_error(what) {} + explicit ProjectionError(const char * what) : std::runtime_error(what) {} }; - template struct Projection_traits {}; + template + struct Projection_traits {}; /** * defines the interface which must be implemented by projection operators */ - template class ProjectionBase { + template + class ProjectionBase { public: //! Eigen type to replace fields using Vector_t = Eigen::Matrix; //! type of fft_engine used using FFTEngine = FFTEngineBase; //! reference to fft engine is safely managed through a `std::unique_ptr` using FFTEngine_ptr = std::unique_ptr; //! cell coordinates type using Ccoord = typename FFTEngine::Ccoord; //! spatial coordinates type using Rcoord = Rcoord_t; //! global FieldCollection using GFieldCollection_t = typename FFTEngine::GFieldCollection_t; //! local FieldCollection (for Fourier-space pixels) using LFieldCollection_t = typename FFTEngine::LFieldCollection_t; //! Field type on which to apply the projection using Field_t = TypedField; /** * iterator over all pixels. This is taken from the FFT engine, * because depending on the real-to-complex FFT employed, only * roughly half of the pixels are present in Fourier space * (because of the hermitian nature of the transform) */ using iterator = typename FFTEngine::iterator; //! Default constructor ProjectionBase() = delete; //! Constructor with cell sizes ProjectionBase(FFTEngine_ptr engine, Rcoord domain_lengths, Formulation form); //! Copy constructor - ProjectionBase(const ProjectionBase &other) = delete; + ProjectionBase(const ProjectionBase & other) = delete; //! Move constructor - ProjectionBase(ProjectionBase &&other) = default; + ProjectionBase(ProjectionBase && other) = default; //! Destructor virtual ~ProjectionBase() = default; //! Copy assignment operator - ProjectionBase &operator=(const ProjectionBase &other) = delete; + ProjectionBase & operator=(const ProjectionBase & other) = delete; //! Move assignment operator - ProjectionBase &operator=(ProjectionBase &&other) = default; + ProjectionBase & operator=(ProjectionBase && other) = default; //! initialises the fft engine (plan the transform) virtual void initialise(FFT_PlanFlags flags = FFT_PlanFlags::estimate); //! apply the projection operator to a field - virtual void apply_projection(Field_t &field) = 0; + virtual void apply_projection(Field_t & field) = 0; //! returns the process-local resolutions of the cell - const Ccoord &get_subdomain_resolutions() const { + const Ccoord & get_subdomain_resolutions() const { return this->fft_engine->get_subdomain_resolutions(); } //! returns the process-local locations of the cell - const Ccoord &get_subdomain_locations() const { + const Ccoord & get_subdomain_locations() const { return this->fft_engine->get_subdomain_locations(); } //! returns the resolutions of the cell - const Ccoord &get_domain_resolutions() const { + const Ccoord & get_domain_resolutions() const { return this->fft_engine->get_domain_resolutions(); } //! returns the physical sizes of the cell - const Rcoord &get_domain_lengths() const { return this->domain_lengths; } + const Rcoord & get_domain_lengths() const { return this->domain_lengths; } /** * return the `muSpectre::Formulation` that is used in solving * this cell. This allows tho check whether a projection is * compatible with the chosen formulation */ - const Formulation &get_formulation() const { return this->form; } + const Formulation & get_formulation() const { return this->form; } //! return the raw projection operator. This is mainly intended //! for maintenance and debugging and should never be required in //! regular use virtual Eigen::Map get_operator() = 0; //! return the communicator object - const Communicator &get_communicator() const { + const Communicator & get_communicator() const { return this->fft_engine->get_communicator(); } /** * returns the number of rows and cols for the strain matrix type * (for full storage, the strain is stored in material_dim × * material_dim matrices, but in symmetriy storage, it is a column * vector) */ virtual std::array get_strain_shape() const = 0; //! get number of components to project per pixel virtual Dim_t get_nb_components() const { return DimM * DimM; } protected: //! handle on the fft_engine used FFTEngine_ptr fft_engine; const Rcoord domain_lengths; //!< physical sizes of the cell /** * formulation this projection can be applied to (determines * whether the projection enforces gradients, small strain tensor * or symmetric smal strain tensor */ const Formulation form; /** * A local `muSpectre::FieldCollection` to store the projection * operator per k-space point. This is a local rather than a * global collection, since the pixels considered depend on the * FFT implementation. See * http://www.fftw.org/fftw3_doc/Multi_002dDimensional-DFTs-of-Real-Data.html#Multi_002dDimensional-DFTs-of-Real-Data * for an example */ - LFieldCollection_t &projection_container{}; + LFieldCollection_t & projection_container{}; private: }; } // namespace muSpectre #endif // SRC_FFT_PROJECTION_BASE_HH_ diff --git a/src/fft/projection_default.cc b/src/fft/projection_default.cc index 5fff225..078e412 100644 --- a/src/fft/projection_default.cc +++ b/src/fft/projection_default.cc @@ -1,78 +1,78 @@ /** * @file projection_default.cc * * @author Till Junge * * @date 14 Jan 2018 * * @brief Implementation default projection implementation * * Copyright © 2018 Till Junge * * µSpectre 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, 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 Lesser General Public License * along with µSpectre; see the file COPYING. If not, write to the * Free Software Foundation, Inc., 59 Temple Place - Suite 330, * * Boston, MA 02111-1307, USA. * * Additional permission under GNU GPL version 3 section 7 * * If you modify this Program, or any covered work, by linking or combining it * with proprietary FFT implementations or numerical libraries, containing parts * covered by the terms of those libraries' licenses, the licensors of this * Program grant you additional permission to convey the resulting work. */ #include "fft/projection_default.hh" #include "fft/fft_engine_base.hh" namespace muSpectre { /* ---------------------------------------------------------------------- */ template ProjectionDefault::ProjectionDefault(FFTEngine_ptr engine, Rcoord lengths, Formulation form) : Parent{std::move(engine), lengths, form}, Gfield{make_field("Projection Operator", this->projection_container)}, Ghat{Gfield} {} /* ---------------------------------------------------------------------- */ template - void ProjectionDefault::apply_projection(Field_t &field) { + void ProjectionDefault::apply_projection(Field_t & field) { Vector_map field_map{this->fft_engine->fft(field)}; Real factor = this->fft_engine->normalisation(); - for (auto &&tup : akantu::zip(this->Ghat, field_map)) { - auto &G{std::get<0>(tup)}; - auto &f{std::get<1>(tup)}; + for (auto && tup : akantu::zip(this->Ghat, field_map)) { + auto & G{std::get<0>(tup)}; + auto & f{std::get<1>(tup)}; f = factor * (G * f).eval(); } this->fft_engine->ifft(field); } /* ---------------------------------------------------------------------- */ template Eigen::Map ProjectionDefault::get_operator() { return this->Gfield.dyn_eigen(); } /* ---------------------------------------------------------------------- */ template std::array ProjectionDefault::get_strain_shape() const { return std::array{DimM, DimM}; } /* ---------------------------------------------------------------------- */ template class ProjectionDefault; template class ProjectionDefault; } // namespace muSpectre diff --git a/src/fft/projection_default.hh b/src/fft/projection_default.hh index 363ba16..e106cfb 100644 --- a/src/fft/projection_default.hh +++ b/src/fft/projection_default.hh @@ -1,117 +1,117 @@ /** * @file projection_default.hh * * @author Till Junge * * @date 14 Jan 2018 * * @brief virtual base class for default projection implementation, where the * projection operator is stored as a full fourth-order tensor per * k-space point (as opposed to 'smart' faster implementations, such as * ProjectionFiniteStrainFast * * Copyright (C) 2018 Till Junge * * µSpectre 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, 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 Lesser General Public License * along with µSpectre; see the file COPYING. If not, write to the * Free Software Foundation, Inc., 59 Temple Place - Suite 330, * * Boston, MA 02111-1307, USA. * * Additional permission under GNU GPL version 3 section 7 * * If you modify this Program, or any covered work, by linking or combining it * with proprietary FFT implementations or numerical libraries, containing parts * covered by the terms of those libraries' licenses, the licensors of this * Program grant you additional permission to convey the resulting work. */ #ifndef SRC_FFT_PROJECTION_DEFAULT_HH_ #define SRC_FFT_PROJECTION_DEFAULT_HH_ #include "fft/projection_base.hh" namespace muSpectre { /** * base class to inherit from if one implements a projection * operator that is stored in form of a fourth-order tensor of real * values per k-grid point */ template class ProjectionDefault : public ProjectionBase { public: using Parent = ProjectionBase; //!< base class using Vector_t = typename Parent::Vector_t; //!< to represent fields //! polymorphic FFT pointer type using FFTEngine_ptr = typename Parent::FFTEngine_ptr; using Ccoord = typename Parent::Ccoord; //!< cell coordinates type using Rcoord = typename Parent::Rcoord; //!< spatial coordinates type //! global field collection using GFieldCollection_t = GlobalFieldCollection; //! local field collection for Fourier-space fields using LFieldCollection_t = LocalFieldCollection; //! Real space second order tensor fields (to be projected) using Field_t = TypedField; //! Fourier-space field containing the projection operator itself using Proj_t = TensorField; //! iterable form of the operator using Proj_map = T4MatrixFieldMap; //! vectorized version of the Fourier-space second-order tensor field using Vector_map = MatrixFieldMap; //! Default constructor ProjectionDefault() = delete; //! Constructor with cell sizes and formulation ProjectionDefault(FFTEngine_ptr engine, Rcoord lengths, Formulation form); //! Copy constructor - ProjectionDefault(const ProjectionDefault &other) = delete; + ProjectionDefault(const ProjectionDefault & other) = delete; //! Move constructor - ProjectionDefault(ProjectionDefault &&other) = default; + ProjectionDefault(ProjectionDefault && other) = default; //! Destructor virtual ~ProjectionDefault() = default; //! Copy assignment operator - ProjectionDefault &operator=(const ProjectionDefault &other) = delete; + ProjectionDefault & operator=(const ProjectionDefault & other) = delete; //! Move assignment operator - ProjectionDefault &operator=(ProjectionDefault &&other) = delete; + ProjectionDefault & operator=(ProjectionDefault && other) = delete; //! apply the projection operator to a field - void apply_projection(Field_t &field) final; + void apply_projection(Field_t & field) final; Eigen::Map get_operator() final; /** * returns the number of rows and cols for the strain matrix type * (for full storage, the strain is stored in material_dim × * material_dim matrices, but in symmetriy storage, it is a column * vector) */ std::array get_strain_shape() const final; constexpr static Dim_t NbComponents() { return ipow(DimM, 2); } protected: - Proj_t &Gfield; //!< field holding the operator - Proj_map Ghat; //!< iterable version of operator + Proj_t & Gfield; //!< field holding the operator + Proj_map Ghat; //!< iterable version of operator private: }; } // namespace muSpectre #endif // SRC_FFT_PROJECTION_DEFAULT_HH_ diff --git a/src/fft/projection_finite_strain.cc b/src/fft/projection_finite_strain.cc index 35359a6..b195922 100644 --- a/src/fft/projection_finite_strain.cc +++ b/src/fft/projection_finite_strain.cc @@ -1,97 +1,97 @@ /** * @file projection_finite_strain.cc * * @author Till Junge * * @date 05 Dec 2017 * * @brief implementation of standard finite strain projection operator * * Copyright © 2017 Till Junge * * µSpectre 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, 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 Lesser General Public License * along with µSpectre; see the file COPYING. If not, write to the * Free Software Foundation, Inc., 59 Temple Place - Suite 330, * * Boston, MA 02111-1307, USA. * * Additional permission under GNU GPL version 3 section 7 * * If you modify this Program, or any covered work, by linking or combining it * with proprietary FFT implementations or numerical libraries, containing parts * covered by the terms of those libraries' licenses, the licensors of this * Program grant you additional permission to convey the resulting work. */ #include "fft/projection_finite_strain.hh" #include "common/field_map.hh" #include "common/iterators.hh" #include "common/tensor_algebra.hh" #include "fft/fft_utils.hh" #include "fft/fftw_engine.hh" #include "Eigen/Dense" namespace muSpectre { /* ---------------------------------------------------------------------- */ template ProjectionFiniteStrain::ProjectionFiniteStrain( FFTEngine_ptr engine, Rcoord lengths) : Parent{std::move(engine), lengths, Formulation::finite_strain} { for (auto res : this->fft_engine->get_domain_resolutions()) { if (res % 2 == 0) { throw ProjectionError( "Only an odd number of gridpoints in each direction is supported"); } } } /* ---------------------------------------------------------------------- */ template void ProjectionFiniteStrain::initialise(FFT_PlanFlags flags) { Parent::initialise(flags); FFT_freqs fft_freqs(this->fft_engine->get_domain_resolutions(), this->domain_lengths); - for (auto &&tup : akantu::zip(*this->fft_engine, this->Ghat)) { - const auto &ccoord = std::get<0>(tup); - auto &G = std::get<1>(tup); + for (auto && tup : akantu::zip(*this->fft_engine, this->Ghat)) { + const auto & ccoord = std::get<0>(tup); + auto & G = std::get<1>(tup); auto xi = fft_freqs.get_unit_xi(ccoord); //! this is simplifiable using Curnier's Méthodes numériques, 6.69(c) G = Matrices::outer_under(Matrices::I2(), xi * xi.transpose()); // The commented block below corresponds to the original // definition of the operator in de Geus et // al. (https://doi.org/10.1016/j.cma.2016.12.032). However, // they use a bizarre definition of the double contraction // between fourth-order and second-order tensors that has a // built-in transpose operation (i.e., C = A:B <-> AᵢⱼₖₗBₗₖ = // Cᵢⱼ , note the inverted ₗₖ instead of ₖₗ), here, we define // the double contraction without the transposition. As a // result, the Projection operator produces the transpose of de // Geus's // for (Dim_t im = 0; im < DimS; ++im) { // for (Dim_t j = 0; j < DimS; ++j) { // for (Dim_t l = 0; l < DimS; ++l) { // get(G, im, j, l, im) = xi(j)*xi(l); // } // } // } } if (this->get_subdomain_locations() == Ccoord{}) { this->Ghat[0].setZero(); } } template class ProjectionFiniteStrain; template class ProjectionFiniteStrain; } // namespace muSpectre diff --git a/src/fft/projection_finite_strain.hh b/src/fft/projection_finite_strain.hh index b760030..796af6b 100644 --- a/src/fft/projection_finite_strain.hh +++ b/src/fft/projection_finite_strain.hh @@ -1,96 +1,96 @@ /** * @file projection_finite_strain.hh * * @author Till Junge * * @date 05 Dec 2017 * * @brief Class for standard finite-strain gradient projections see de Geus et * al. (https://doi.org/10.1016/j.cma.2016.12.032) for derivation * * Copyright © 2017 Till Junge * * µSpectre 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, 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 Lesser General Public License * along with µSpectre; see the file COPYING. If not, write to the * Free Software Foundation, Inc., 59 Temple Place - Suite 330, * * Boston, MA 02111-1307, USA. * * Additional permission under GNU GPL version 3 section 7 * * If you modify this Program, or any covered work, by linking or combining it * with proprietary FFT implementations or numerical libraries, containing parts * covered by the terms of those libraries' licenses, the licensors of this * Program grant you additional permission to convey the resulting work. */ #ifndef SRC_FFT_PROJECTION_FINITE_STRAIN_HH_ #define SRC_FFT_PROJECTION_FINITE_STRAIN_HH_ #include "fft/projection_default.hh" #include "common/common.hh" #include "common/field_collection.hh" #include "common/field_map.hh" namespace muSpectre { /** * Implements the finite strain gradient projection operator as * defined in de Geus et * al. (https://doi.org/10.1016/j.cma.2016.12.032) for derivation */ template class ProjectionFiniteStrain : public ProjectionDefault { public: using Parent = ProjectionDefault; //!< base class //! polymorphic pointer to FFT engines using FFTEngine_ptr = typename Parent::FFTEngine_ptr; using Ccoord = typename Parent::Ccoord; //!< cell coordinates type using Rcoord = typename Parent::Rcoord; //!< spatial coordinates type //! local field collection (for Fourier-space representations) using LFieldCollection_t = LocalFieldCollection; //! iterable operator using Proj_map = T4MatrixFieldMap; //! iterable vectorised version of the Fourier-space tensor field using Vector_map = MatrixFieldMap; //! Default constructor ProjectionFiniteStrain() = delete; //! Constructor with fft_engine ProjectionFiniteStrain(FFTEngine_ptr engine, Rcoord lengths); //! Copy constructor - ProjectionFiniteStrain(const ProjectionFiniteStrain &other) = delete; + ProjectionFiniteStrain(const ProjectionFiniteStrain & other) = delete; //! Move constructor - ProjectionFiniteStrain(ProjectionFiniteStrain &&other) = default; + ProjectionFiniteStrain(ProjectionFiniteStrain && other) = default; //! Destructor virtual ~ProjectionFiniteStrain() = default; //! Copy assignment operator ProjectionFiniteStrain & - operator=(const ProjectionFiniteStrain &other) = delete; + operator=(const ProjectionFiniteStrain & other) = delete; //! Move assignment operator - ProjectionFiniteStrain &operator=(ProjectionFiniteStrain &&other) = default; + ProjectionFiniteStrain & + operator=(ProjectionFiniteStrain && other) = default; //! initialises the fft engine (plan the transform) - void - initialise(FFT_PlanFlags flags = FFT_PlanFlags::estimate) final; + void initialise(FFT_PlanFlags flags = FFT_PlanFlags::estimate) final; }; } // namespace muSpectre #endif // SRC_FFT_PROJECTION_FINITE_STRAIN_HH_ diff --git a/src/fft/projection_finite_strain_fast.cc b/src/fft/projection_finite_strain_fast.cc index 6d96fde..e6bb5e0 100644 --- a/src/fft/projection_finite_strain_fast.cc +++ b/src/fft/projection_finite_strain_fast.cc @@ -1,104 +1,104 @@ /** * @file projection_finite_strain_fast.cc * * @author Till Junge * * @date 12 Dec 2017 * * @brief implementation for fast projection in finite strain * * Copyright © 2017 Till Junge * * µSpectre 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, 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 Lesser General Public License * along with µSpectre; see the file COPYING. If not, write to the * Free Software Foundation, Inc., 59 Temple Place - Suite 330, * * Boston, MA 02111-1307, USA. * * Additional permission under GNU GPL version 3 section 7 * * If you modify this Program, or any covered work, by linking or combining it * with proprietary FFT implementations or numerical libraries, containing parts * covered by the terms of those libraries' licenses, the licensors of this * Program grant you additional permission to convey the resulting work. */ #include "fft/projection_finite_strain_fast.hh" #include "fft/fft_utils.hh" #include "common/tensor_algebra.hh" #include "common/iterators.hh" namespace muSpectre { /* ---------------------------------------------------------------------- */ template ProjectionFiniteStrainFast::ProjectionFiniteStrainFast( FFTEngine_ptr engine, Rcoord lengths) : Parent{std::move(engine), lengths, Formulation::finite_strain}, xiField{make_field("Projection Operator", this->projection_container)}, xis(xiField) { for (auto res : this->fft_engine->get_domain_resolutions()) { if (res % 2 == 0) { throw ProjectionError( "Only an odd number of gridpoints in each direction is supported"); } } } /* ---------------------------------------------------------------------- */ template void ProjectionFiniteStrainFast::initialise(FFT_PlanFlags flags) { Parent::initialise(flags); FFT_freqs fft_freqs(this->fft_engine->get_domain_resolutions(), this->domain_lengths); - for (auto &&tup : akantu::zip(*this->fft_engine, this->xis)) { - const auto &ccoord = std::get<0>(tup); - auto &xi = std::get<1>(tup); + for (auto && tup : akantu::zip(*this->fft_engine, this->xis)) { + const auto & ccoord = std::get<0>(tup); + auto & xi = std::get<1>(tup); xi = fft_freqs.get_unit_xi(ccoord); } if (this->get_subdomain_locations() == Ccoord{}) { this->xis[0].setZero(); } } /* ---------------------------------------------------------------------- */ template void - ProjectionFiniteStrainFast::apply_projection(Field_t &field) { + ProjectionFiniteStrainFast::apply_projection(Field_t & field) { Grad_map field_map{this->fft_engine->fft(field)}; Real factor = this->fft_engine->normalisation(); - for (auto &&tup : akantu::zip(this->xis, field_map)) { - auto &xi{std::get<0>(tup)}; - auto &f{std::get<1>(tup)}; + for (auto && tup : akantu::zip(this->xis, field_map)) { + auto & xi{std::get<0>(tup)}; + auto & f{std::get<1>(tup)}; f = factor * ((f * xi).eval() * xi.transpose()); } this->fft_engine->ifft(field); } /* ---------------------------------------------------------------------- */ template Eigen::Map ProjectionFiniteStrainFast::get_operator() { return this->xiField.dyn_eigen(); } /* ---------------------------------------------------------------------- */ template std::array ProjectionFiniteStrainFast::get_strain_shape() const { return std::array{DimM, DimM}; } /* ---------------------------------------------------------------------- */ template class ProjectionFiniteStrainFast; template class ProjectionFiniteStrainFast; } // namespace muSpectre diff --git a/src/fft/projection_finite_strain_fast.hh b/src/fft/projection_finite_strain_fast.hh index 76efd07..cfd7aa4 100644 --- a/src/fft/projection_finite_strain_fast.hh +++ b/src/fft/projection_finite_strain_fast.hh @@ -1,124 +1,123 @@ /** * @file projection_finite_strain_fast.hh * * @author Till Junge * * @date 12 Dec 2017 * * @brief Faster alternative to ProjectionFinitestrain * * Copyright © 2017 Till Junge * * µSpectre 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, 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 Lesser General Public License * along with µSpectre; see the file COPYING. If not, write to the * Free Software Foundation, Inc., 59 Temple Place - Suite 330, * * Boston, MA 02111-1307, USA. * * Additional permission under GNU GPL version 3 section 7 * * If you modify this Program, or any covered work, by linking or combining it * with proprietary FFT implementations or numerical libraries, containing parts * covered by the terms of those libraries' licenses, the licensors of this * Program grant you additional permission to convey the resulting work. */ #ifndef SRC_FFT_PROJECTION_FINITE_STRAIN_FAST_HH_ #define SRC_FFT_PROJECTION_FINITE_STRAIN_FAST_HH_ #include "fft/projection_base.hh" #include "common/common.hh" #include "common/field_collection.hh" #include "common/field_map.hh" namespace muSpectre { /** * replaces `muSpectre::ProjectionFiniteStrain` with a faster and * less memory-hungry alternative formulation. Use this if you don't * have a very good reason not to (and tell me (author) about it, * I'd be interested to hear it). */ template class ProjectionFiniteStrainFast : public ProjectionBase { public: using Parent = ProjectionBase; //!< base class //! polymorphic pointer to FFT engines using FFTEngine_ptr = typename Parent::FFTEngine_ptr; using Ccoord = typename Parent::Ccoord; //!< cell coordinates type using Rcoord = typename Parent::Rcoord; //!< spatial coordinates type //! global field collection (for real-space representations) using GFieldCollection_t = GlobalFieldCollection; //! local field collection (for Fourier-space representations) using LFieldCollection_t = LocalFieldCollection; //! Real space second order tensor fields (to be projected) using Field_t = TypedField; //! Fourier-space field containing the projection operator itself using Proj_t = TensorField; //! iterable form of the operator using Proj_map = MatrixFieldMap; //! iterable Fourier-space second-order tensor field using Grad_map = MatrixFieldMap; //! Default constructor ProjectionFiniteStrainFast() = delete; //! Constructor with fft_engine ProjectionFiniteStrainFast(FFTEngine_ptr engine, Rcoord lengths); //! Copy constructor - ProjectionFiniteStrainFast(const ProjectionFiniteStrainFast &other) = + ProjectionFiniteStrainFast(const ProjectionFiniteStrainFast & other) = delete; //! Move constructor - ProjectionFiniteStrainFast(ProjectionFiniteStrainFast &&other) = default; + ProjectionFiniteStrainFast(ProjectionFiniteStrainFast && other) = default; //! Destructor virtual ~ProjectionFiniteStrainFast() = default; //! Copy assignment operator ProjectionFiniteStrainFast & - operator=(const ProjectionFiniteStrainFast &other) = delete; + operator=(const ProjectionFiniteStrainFast & other) = delete; //! Move assignment operator ProjectionFiniteStrainFast & - operator=(ProjectionFiniteStrainFast &&other) = default; + operator=(ProjectionFiniteStrainFast && other) = default; //! initialises the fft engine (plan the transform) - void - initialise(FFT_PlanFlags flags = FFT_PlanFlags::estimate) final; + void initialise(FFT_PlanFlags flags = FFT_PlanFlags::estimate) final; //! apply the projection operator to a field - void apply_projection(Field_t &field) final; + void apply_projection(Field_t & field) final; Eigen::Map get_operator() final; /** * returns the number of rows and cols for the strain matrix type * (for full storage, the strain is stored in material_dim × * material_dim matrices, but in symmetriy storage, it is a column * vector) */ std::array get_strain_shape() const final; constexpr static Dim_t NbComponents() { return ipow(DimM, 2); } protected: - Proj_t &xiField; //!< field of normalised wave vectors - Proj_map xis; //!< iterable normalised wave vectors + Proj_t & xiField; //!< field of normalised wave vectors + Proj_map xis; //!< iterable normalised wave vectors private: }; } // namespace muSpectre #endif // SRC_FFT_PROJECTION_FINITE_STRAIN_FAST_HH_ diff --git a/src/fft/projection_small_strain.cc b/src/fft/projection_small_strain.cc index 8a22557..7f5d77f 100644 --- a/src/fft/projection_small_strain.cc +++ b/src/fft/projection_small_strain.cc @@ -1,89 +1,89 @@ /** * @file projection_small_strain.cc * * @author Till Junge * * @date 14 Jan 2018 * * @brief Implementation for ProjectionSmallStrain * * Copyright © 2018 Till Junge * * µSpectre 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, 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 Lesser General Public License * along with µSpectre; see the file COPYING. If not, write to the * Free Software Foundation, Inc., 59 Temple Place - Suite 330, * * Boston, MA 02111-1307, USA. * * Additional permission under GNU GPL version 3 section 7 * * If you modify this Program, or any covered work, by linking or combining it * with proprietary FFT implementations or numerical libraries, containing parts * covered by the terms of those libraries' licenses, the licensors of this * Program grant you additional permission to convey the resulting work. */ #include "fft/projection_small_strain.hh" #include "fft/fft_utils.hh" namespace muSpectre { /* ---------------------------------------------------------------------- */ template ProjectionSmallStrain::ProjectionSmallStrain(FFTEngine_ptr engine, Rcoord lengths) : Parent{std::move(engine), lengths, Formulation::small_strain} { for (auto res : this->fft_engine->get_domain_resolutions()) { if (res % 2 == 0) { throw ProjectionError( "Only an odd number of gridpoints in each direction is supported"); } } } /* ---------------------------------------------------------------------- */ template void ProjectionSmallStrain::initialise(FFT_PlanFlags flags) { Parent::initialise(flags); FFT_freqs fft_freqs(this->fft_engine->get_domain_resolutions(), this->domain_lengths); - for (auto &&tup : akantu::zip(*this->fft_engine, this->Ghat)) { - const auto &ccoord = std::get<0>(tup); - auto &G = std::get<1>(tup); + for (auto && tup : akantu::zip(*this->fft_engine, this->Ghat)) { + const auto & ccoord = std::get<0>(tup); + auto & G = std::get<1>(tup); auto xi = fft_freqs.get_unit_xi(ccoord); auto kron = [](const Dim_t i, const Dim_t j) -> Real { return (i == j) ? 1. : 0.; }; for (Dim_t i{0}; i < DimS; ++i) { for (Dim_t j{0}; j < DimS; ++j) { for (Dim_t l{0}; l < DimS; ++l) { for (Dim_t m{0}; m < DimS; ++m) { - Real &g = get(G, i, j, l, m); + Real & g = get(G, i, j, l, m); g = 0.5 * (xi(i) * kron(j, l) * xi(m) + xi(i) * kron(j, m) * xi(l) + xi(j) * kron(i, l) * xi(m) + xi(j) * kron(i, m) * xi(l)) - xi(i) * xi(j) * xi(l) * xi(m); } } } } } if (this->get_subdomain_locations() == Ccoord{}) { this->Ghat[0].setZero(); } } template class ProjectionSmallStrain; template class ProjectionSmallStrain; } // namespace muSpectre diff --git a/src/fft/projection_small_strain.hh b/src/fft/projection_small_strain.hh index 46d5d2e..324eef1 100644 --- a/src/fft/projection_small_strain.hh +++ b/src/fft/projection_small_strain.hh @@ -1,99 +1,98 @@ /** * @file projection_small_strain.cc * * @author Till Junge * * @date 14 Jan 2018 * * @brief Small strain projection operator as defined in Appendix A1 of * DOI: 10.1002/nme.5481 ("A finite element perspective on nonlinear * FFT-based micromechanical simulations", Int. J. Numer. Meth. Engng * 2017; 111 :903–926) * * Copyright © 2018 Till Junge * * µSpectre 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, 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 Lesser General Public License * along with µSpectre; see the file COPYING. If not, write to the * Free Software Foundation, Inc., 59 Temple Place - Suite 330, * * Boston, MA 02111-1307, USA. * * Additional permission under GNU GPL version 3 section 7 * * If you modify this Program, or any covered work, by linking or combining it * with proprietary FFT implementations or numerical libraries, containing parts * covered by the terms of those libraries' licenses, the licensors of this * Program grant you additional permission to convey the resulting work. */ #ifndef SRC_FFT_PROJECTION_SMALL_STRAIN_HH_ #define SRC_FFT_PROJECTION_SMALL_STRAIN_HH_ #include "fft/projection_default.hh" namespace muSpectre { /** * Implements the small strain projection operator as defined in * Appendix A1 of DOI: 10.1002/nme.5481 ("A finite element * perspective on nonlinear FFT-based micromechanical * simulations", Int. J. Numer. Meth. Engng 2017; 111 * :903–926) */ template class ProjectionSmallStrain : public ProjectionDefault { public: using Parent = ProjectionDefault; //!< base class //! polymorphic pointer to FFT engines using FFTEngine_ptr = typename Parent::FFTEngine_ptr; using Ccoord = typename Parent::Ccoord; //!< cell coordinates type using Rcoord = typename Parent::Rcoord; //!< spatial coordinates type //! local field collection (for Fourier-space representations) using LFieldCollection_t = LocalFieldCollection; //! Fourier-space field containing the projection operator itself using Proj_t = TensorField; //! iterable operator using Proj_map = T4MatrixFieldMap; //! iterable vectorised version of the Fourier-space tensor field using Vector_map = MatrixFieldMap; //! Default constructor ProjectionSmallStrain() = delete; //! Constructor with fft_engine ProjectionSmallStrain(FFTEngine_ptr engine, Rcoord lengths); //! Copy constructor - ProjectionSmallStrain(const ProjectionSmallStrain &other) = delete; + ProjectionSmallStrain(const ProjectionSmallStrain & other) = delete; //! Move constructor - ProjectionSmallStrain(ProjectionSmallStrain &&other) = default; + ProjectionSmallStrain(ProjectionSmallStrain && other) = default; //! Destructor virtual ~ProjectionSmallStrain() = default; //! Copy assignment operator ProjectionSmallStrain & - operator=(const ProjectionSmallStrain &other) = delete; + operator=(const ProjectionSmallStrain & other) = delete; //! Move assignment operator - ProjectionSmallStrain &operator=(ProjectionSmallStrain &&other) = delete; + ProjectionSmallStrain & operator=(ProjectionSmallStrain && other) = delete; //! initialises the fft engine (plan the transform) - void - initialise(FFT_PlanFlags flags = FFT_PlanFlags::estimate) final; + void initialise(FFT_PlanFlags flags = FFT_PlanFlags::estimate) final; }; } // namespace muSpectre #endif // SRC_FFT_PROJECTION_SMALL_STRAIN_HH_ diff --git a/src/materials/material_base.cc b/src/materials/material_base.cc index 0ce49ac..1fe263c 100644 --- a/src/materials/material_base.cc +++ b/src/materials/material_base.cc @@ -1,81 +1,82 @@ /** * @file material_base.cc * * @author Till Junge * * @date 01 Nov 2017 * * @brief implementation of materi * * Copyright © 2017 Till Junge * * µSpectre 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, 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 Lesser General Public License * along with µSpectre; see the file COPYING. If not, write to the * Free Software Foundation, Inc., 59 Temple Place - Suite 330, * * Boston, MA 02111-1307, USA. * * Additional permission under GNU GPL version 3 section 7 * * If you modify this Program, or any covered work, by linking or combining it * with proprietary FFT implementations or numerical libraries, containing parts * covered by the terms of those libraries' licenses, the licensors of this * Program grant you additional permission to convey the resulting work. */ #include "materials/material_base.hh" namespace muSpectre { //----------------------------------------------------------------------------// template MaterialBase::MaterialBase(std::string name) : name(name) { static_assert((DimM == oneD) || (DimM == twoD) || (DimM == threeD), "only 1, 2, or threeD supported"); } /* ---------------------------------------------------------------------- */ template - const std::string &MaterialBase::get_name() const { + const std::string & MaterialBase::get_name() const { return this->name; } /* ---------------------------------------------------------------------- */ template - void MaterialBase::add_pixel(const Ccoord &ccoord) { + void MaterialBase::add_pixel(const Ccoord & ccoord) { this->internal_fields.add_pixel(ccoord); } /* ---------------------------------------------------------------------- */ template - void MaterialBase::compute_stresses(const Field_t &F, Field_t &P, + void MaterialBase::compute_stresses(const Field_t & F, + Field_t & P, Formulation form) { this->compute_stresses(StrainField_t::check_ref(F), StressField_t::check_ref(P), form); } /* ---------------------------------------------------------------------- */ template - void MaterialBase::compute_stresses_tangent(const Field_t &F, - Field_t &P, - Field_t &K, + void MaterialBase::compute_stresses_tangent(const Field_t & F, + Field_t & P, + Field_t & K, Formulation form) { this->compute_stresses_tangent(StrainField_t::check_ref(F), StressField_t::check_ref(P), TangentField_t::check_ref(K), form); } template class MaterialBase<2, 2>; template class MaterialBase<2, 3>; template class MaterialBase<3, 3>; } // namespace muSpectre diff --git a/src/materials/material_base.hh b/src/materials/material_base.hh index da47fdc..635124c 100644 --- a/src/materials/material_base.hh +++ b/src/materials/material_base.hh @@ -1,165 +1,164 @@ /** * @file material_base.hh * * @author Till Junge * * @date 25 Oct 2017 * * @brief Base class for materials (constitutive models) * * Copyright © 2017 Till Junge * * µSpectre 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, 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 Lesser General Public License * along with µSpectre; see the file COPYING. If not, write to the * Free Software Foundation, Inc., 59 Temple Place - Suite 330, * * Boston, MA 02111-1307, USA. * * Additional permission under GNU GPL version 3 section 7 * * If you modify this Program, or any covered work, by linking or combining it * with proprietary FFT implementations or numerical libraries, containing parts * covered by the terms of those libraries' licenses, the licensors of this * Program grant you additional permission to convey the resulting work. */ #ifndef SRC_MATERIALS_MATERIAL_BASE_HH_ #define SRC_MATERIALS_MATERIAL_BASE_HH_ #include "common/common.hh" #include "common/field.hh" #include "common/field_collection.hh" #include namespace muSpectre { //! DimS spatial dimension (dimension of problem //! DimM material_dimension (dimension of constitutive law) and /** * @a DimM is the material dimension (i.e., the dimension of constitutive * law; even for e.g. two-dimensional problems the constitutive law could * live in three-dimensional space for e.g. plane strain or stress problems) */ - template class MaterialBase { + template + class MaterialBase { public: //! typedefs for data handled by this interface //! global field collection for cell-wide fields, like stress, strain, etc using GFieldCollection_t = GlobalFieldCollection; //! field collection for internal variables, such as eigen-strains, //! plastic strains, damage variables, etc, but also for managing which //! pixels the material is responsible for using MFieldCollection_t = LocalFieldCollection; using iterator = typename MFieldCollection_t::iterator; //!< pixel iterator //! polymorphic base class for fields only to be used for debugging using Field_t = internal::FieldBase; //! Full type for stress fields using StressField_t = TensorField; //! Full type for strain fields using StrainField_t = StressField_t; //! Full type for tangent stiffness fields fields using TangentField_t = TensorField; using Ccoord = Ccoord_t; //!< cell coordinates type //! Default constructor MaterialBase() = delete; //! Construct by name explicit MaterialBase(std::string name); //! Copy constructor - MaterialBase(const MaterialBase &other) = delete; + MaterialBase(const MaterialBase & other) = delete; //! Move constructor - MaterialBase(MaterialBase &&other) = delete; + MaterialBase(MaterialBase && other) = delete; //! Destructor virtual ~MaterialBase() = default; //! Copy assignment operator - MaterialBase &operator=(const MaterialBase &other) = delete; + MaterialBase & operator=(const MaterialBase & other) = delete; //! Move assignment operator - MaterialBase &operator=(MaterialBase &&other) = delete; + MaterialBase & operator=(MaterialBase && other) = delete; /** * take responsibility for a pixel identified by its cell coordinates * WARNING: this won't work for materials with additional info per pixel * (as, e.g. for eigenstrain), we need to pass more parameters. Materials * of this tye need to overload add_pixel */ - virtual void add_pixel(const Ccoord &ccooord); + virtual void add_pixel(const Ccoord & ccooord); //! allocate memory, etc, but also: wipe history variables! virtual void initialise() = 0; /** * for materials with state variables, these typically need to be * saved/updated an the end of each load increment, the virtual * base implementation does nothing, but materials with history * variables need to implement this */ virtual void save_history_variables() {} //! return the material's name - const std::string &get_name() const; + const std::string & get_name() const; //! spatial dimension for static inheritance constexpr static Dim_t sdim() { return DimS; } //! material dimension for static inheritance constexpr static Dim_t mdim() { return DimM; } //! computes stress - virtual void compute_stresses(const StrainField_t &F, StressField_t &P, + virtual void compute_stresses(const StrainField_t & F, StressField_t & P, Formulation form) = 0; /** * Convenience function to compute stresses, mostly for debugging and * testing. Has runtime-cost associated with compatibility-checking and * conversion of the Field_t arguments that can be avoided by using the * version with strongly typed field references */ - void compute_stresses(const Field_t &F, Field_t &P, Formulation form); + void compute_stresses(const Field_t & F, Field_t & P, Formulation form); //! computes stress and tangent moduli - virtual void compute_stresses_tangent(const StrainField_t &F, - StressField_t &P, TangentField_t &K, + virtual void compute_stresses_tangent(const StrainField_t & F, + StressField_t & P, TangentField_t & K, Formulation form) = 0; /** * Convenience function to compute stresses and tangent moduli, mostly for * debugging and testing. Has runtime-cost associated with * compatibility-checking and conversion of the Field_t arguments that can * be avoided by using the version with strongly typed field references */ - void compute_stresses_tangent(const Field_t &F, Field_t &P, Field_t &K, + void compute_stresses_tangent(const Field_t & F, Field_t & P, Field_t & K, Formulation form); //! iterator to first pixel handled by this material inline iterator begin() { return this->internal_fields.begin(); } //! iterator past the last pixel handled by this material inline iterator end() { return this->internal_fields.end(); } //! number of pixels assigned to this material inline size_t size() const { return this->internal_fields.size(); } //! gives access to internal fields - inline MFieldCollection_t &get_collection() { + inline MFieldCollection_t & get_collection() { return this->internal_fields; } protected: const std::string name; //!< material's name (for output and debugging) MFieldCollection_t internal_fields{}; //!< storage for internal variables - - private: }; } // namespace muSpectre #endif // SRC_MATERIALS_MATERIAL_BASE_HH_ diff --git a/src/materials/material_hyper_elasto_plastic1.hh b/src/materials/material_hyper_elasto_plastic1.hh index e2c5c80..1fdeb4e 100644 --- a/src/materials/material_hyper_elasto_plastic1.hh +++ b/src/materials/material_hyper_elasto_plastic1.hh @@ -1,305 +1,306 @@ /** * @file material_hyper_elasto_plastic1.hh * * @author Till Junge * * @date 20 Feb 2018 * * @brief Material for logarithmic hyperelasto-plasticity, as defined in de * Geus 2017 (https://doi.org/10.1016/j.cma.2016.12.032) and further * explained in Geers 2003 (https://doi.org/10.1016/j.cma.2003.07.014) * * Copyright © 2018 Till Junge * * µSpectre 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, 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 Lesser General Public License * along with µSpectre; see the file COPYING. If not, write to the * Free Software Foundation, Inc., 59 Temple Place - Suite 330, * * Boston, MA 02111-1307, USA. * * Additional permission under GNU GPL version 3 section 7 * * If you modify this Program, or any covered work, by linking or combining it * with proprietary FFT implementations or numerical libraries, containing parts * covered by the terms of those libraries' licenses, the licensors of this * Program grant you additional permission to convey the resulting work. */ #ifndef SRC_MATERIALS_MATERIAL_HYPER_ELASTO_PLASTIC1_HH_ #define SRC_MATERIALS_MATERIAL_HYPER_ELASTO_PLASTIC1_HH_ #include "materials/material_muSpectre_base.hh" #include "materials/materials_toolbox.hh" #include "common/eigen_tools.hh" #include "common/statefield.hh" #include namespace muSpectre { - template class MaterialHyperElastoPlastic1; + template + class MaterialHyperElastoPlastic1; /** * traits for hyper-elastoplastic material */ template struct MaterialMuSpectre_traits> { //! global field collection using GFieldCollection_t = typename MaterialBase::GFieldCollection_t; //! expected map type for strain fields using StrainMap_t = MatrixFieldMap; //! expected map type for stress fields using StressMap_t = MatrixFieldMap; //! expected map type for tangent stiffness fields using TangentMap_t = T4MatrixFieldMap; //! declare what type of strain measure your law takes as input constexpr static auto strain_measure{StrainMeasure::Gradient}; //! declare what type of stress measure your law yields as output constexpr static auto stress_measure{StressMeasure::Kirchhoff}; //! local field collection used for internals using LFieldColl_t = LocalFieldCollection; //! storage type for plastic flow measure (εₚ in the papers) using LScalarMap_t = StateFieldMap>; /** * storage type for for previous gradient Fᵗ and elastic left * Cauchy-Green deformation tensor bₑᵗ */ using LStrainMap_t = StateFieldMap>; /** * format in which to receive internals (previous gradient Fᵗ, * previous elastic lef Cauchy-Green deformation tensor bₑᵗ, and * the plastic flow measure εₚ */ using InternalVariables = std::tuple; }; /** * Material implementation for hyper-elastoplastic constitutive law */ template class MaterialHyperElastoPlastic1 : public MaterialMuSpectre, DimS, DimM> { public: //! base class using Parent = MaterialMuSpectre, DimS, DimM>; /** * type used to determine whether the * `muSpectre::MaterialMuSpectre::iterable_proxy` evaluate only * stresses or also tangent stiffnesses */ using NeedTangent = typename Parent::NeedTangent; //! shortcut to traits using traits = MaterialMuSpectre_traits; //! Hooke's law implementation using Hooke = typename MatTB::Hooke; //! type in which the previous strain state is referenced using StrainStRef_t = typename traits::LStrainMap_t::reference; //! type in which the previous plastic flow is referenced using FlowStRef_t = typename traits::LScalarMap_t::reference; //! Default constructor MaterialHyperElastoPlastic1() = delete; //! Constructor with name and material properties MaterialHyperElastoPlastic1(std::string name, Real young, Real poisson, Real tau_y0, Real H); //! Copy constructor - MaterialHyperElastoPlastic1(const MaterialHyperElastoPlastic1 &other) = + MaterialHyperElastoPlastic1(const MaterialHyperElastoPlastic1 & other) = delete; //! Move constructor - MaterialHyperElastoPlastic1(MaterialHyperElastoPlastic1 &&other) = delete; + MaterialHyperElastoPlastic1(MaterialHyperElastoPlastic1 && other) = delete; //! Destructor virtual ~MaterialHyperElastoPlastic1() = default; //! Copy assignment operator MaterialHyperElastoPlastic1 & - operator=(const MaterialHyperElastoPlastic1 &other) = delete; + operator=(const MaterialHyperElastoPlastic1 & other) = delete; //! Move assignment operator MaterialHyperElastoPlastic1 & - operator=(MaterialHyperElastoPlastic1 &&other) = delete; + operator=(MaterialHyperElastoPlastic1 && other) = delete; /** * evaluates Kirchhoff stress given the current placement gradient * Fₜ, the previous Gradient Fₜ₋₁ and the cumulated plastic flow * εₚ */ template - inline decltype(auto) evaluate_stress(grad_t &&F, StrainStRef_t F_prev, + inline decltype(auto) evaluate_stress(grad_t && F, StrainStRef_t F_prev, StrainStRef_t be_prev, FlowStRef_t plast_flow); /** * evaluates Kirchhoff stress and stiffness given the current placement * gradient Fₜ, the previous Gradient Fₜ₋₁ and the cumulated plastic flow εₚ */ template inline decltype(auto) - evaluate_stress_tangent(grad_t &&F, StrainStRef_t F_prev, + evaluate_stress_tangent(grad_t && F, StrainStRef_t F_prev, StrainStRef_t be_prev, FlowStRef_t plast_flow); /** * The statefields need to be cycled at the end of each load increment */ void save_history_variables() override; /** * set the previous gradients to identity */ void initialise() final; /** * return the internals tuple */ - typename traits::InternalVariables &get_internals() { + typename traits::InternalVariables & get_internals() { return this->internal_variables; } protected: /** * worker function computing stresses and internal variables */ template - inline decltype(auto) - stress_n_internals_worker(grad_t &&F, StrainStRef_t &F_prev, - StrainStRef_t &be_prev, FlowStRef_t &plast_flow); + inline decltype(auto) stress_n_internals_worker(grad_t && F, + StrainStRef_t & F_prev, + StrainStRef_t & be_prev, + FlowStRef_t & plast_flow); //! Local FieldCollection type for field storage using LColl_t = LocalFieldCollection; //! storage for cumulated plastic flow εₚ - StateField> &plast_flow_field; + StateField> & plast_flow_field; //! storage for previous gradient Fᵗ - StateField> &F_prev_field; + StateField> & F_prev_field; //! storage for elastic left Cauchy-Green deformation tensor bₑᵗ - StateField> &be_prev_field; + StateField> & be_prev_field; // material properties const Real young; //!< Young's modulus const Real poisson; //!< Poisson's ratio const Real lambda; //!< first Lamé constant const Real mu; //!< second Lamé constant (shear modulus) const Real K; //!< Bulk modulus const Real tau_y0; //!< initial yield stress const Real H; //!< hardening modulus const T4Mat C; //!< stiffness tensor //! Field maps and state field maps over internal fields typename traits::InternalVariables internal_variables; private: }; //--------------------------------------------------------------------------// template template auto MaterialHyperElastoPlastic1::stress_n_internals_worker( - grad_t &&F, StrainStRef_t &F_prev, StrainStRef_t &be_prev, - FlowStRef_t &eps_p) -> decltype(auto) { + grad_t && F, StrainStRef_t & F_prev, StrainStRef_t & be_prev, + FlowStRef_t & eps_p) -> decltype(auto) { // the notation in this function follows Geers 2003 // (https://doi.org/10.1016/j.cma.2003.07.014). // computation of trial state using Mat_t = Eigen::Matrix; - auto &&f{F * F_prev.old().inverse()}; + auto && f{F * F_prev.old().inverse()}; Mat_t be_star{f * be_prev.old() * f.transpose()}; Mat_t ln_be_star{logm(std::move(be_star))}; Mat_t tau_star{.5 * Hooke::evaluate_stress(this->lambda, this->mu, ln_be_star)}; // deviatoric part of Kirchhoff stress Mat_t tau_d_star{tau_star - tau_star.trace() / DimM * tau_star.Identity()}; - auto &&tau_eq_star{std::sqrt( + auto && tau_eq_star{std::sqrt( 3 * .5 * (tau_d_star.array() * tau_d_star.transpose().array()).sum())}; Mat_t N_star{3 * .5 * tau_d_star / tau_eq_star}; // this is eq (27), and the std::min enforces the Kuhn-Tucker relation (16) Real phi_star{ std::max(tau_eq_star - this->tau_y0 - this->H * eps_p.old(), 0.)}; // return mapping Real Del_gamma{phi_star / (this->H + 3 * this->mu)}; - auto &&tau{tau_star - 2 * Del_gamma * this->mu * N_star}; - + auto && tau{tau_star - 2 * Del_gamma * this->mu * N_star}; // update the previous values to the new ones F_prev.current() = F; ln_be_star -= 2 * Del_gamma * N_star; be_prev.current() = expm(std::move(ln_be_star)); eps_p.current() += Del_gamma; // transmit info whether this is a plastic step or not bool is_plastic{phi_star > 0}; return std::tuple( std::move(tau), std::move(tau_eq_star), std::move(Del_gamma), std::move(N_star), std::move(is_plastic)); } //----------------------------------------------------------------------------// template template auto MaterialHyperElastoPlastic1::evaluate_stress( - grad_t &&F, StrainStRef_t F_prev, StrainStRef_t be_prev, + grad_t && F, StrainStRef_t F_prev, StrainStRef_t be_prev, FlowStRef_t eps_p) -> decltype(auto) { auto retval(std::move(std::get<0>(this->stress_n_internals_worker( std::forward(F), F_prev, be_prev, eps_p)))); return retval; } //----------------------------------------------------------------------------// template template auto MaterialHyperElastoPlastic1::evaluate_stress_tangent( - grad_t &&F, StrainStRef_t F_prev, StrainStRef_t be_prev, + grad_t && F, StrainStRef_t F_prev, StrainStRef_t be_prev, FlowStRef_t eps_p) -> decltype(auto) { //! after the stress computation, all internals are up to date - auto &&vals{this->stress_n_internals_worker(std::forward(F), F_prev, - be_prev, eps_p)}; - auto &&tau{std::get<0>(vals)}; - auto &&tau_eq_star{std::get<1>(vals)}; - auto &&Del_gamma{std::get<2>(vals)}; - auto &&N_star{std::get<3>(vals)}; - auto &&is_plastic{std::get<4>(vals)}; + auto && vals{this->stress_n_internals_worker(std::forward(F), + F_prev, be_prev, eps_p)}; + auto && tau{std::get<0>(vals)}; + auto && tau_eq_star{std::get<1>(vals)}; + auto && Del_gamma{std::get<2>(vals)}; + auto && N_star{std::get<3>(vals)}; + auto && is_plastic{std::get<4>(vals)}; if (is_plastic) { - auto &&a0 = Del_gamma * this->mu / tau_eq_star; - auto &&a1 = this->mu / (this->H + 3 * this->mu); + auto && a0 = Del_gamma * this->mu / tau_eq_star; + auto && a1 = this->mu / (this->H + 3 * this->mu); return std::make_tuple( std::move(tau), T4Mat{ ((this->K / 2. - this->mu / 3 + a0 * this->mu) * Matrices::Itrac() + (1 - 3 * a0) * this->mu * Matrices::Isymm() + 2 * this->mu * (a0 - a1) * Matrices::outer(N_star, N_star))}); } else { return std::make_tuple(std::move(tau), T4Mat{this->C}); } } } // namespace muSpectre #endif // SRC_MATERIALS_MATERIAL_HYPER_ELASTO_PLASTIC1_HH_ diff --git a/src/materials/material_linear_elastic1.hh b/src/materials/material_linear_elastic1.hh index 1923bbe..bb4953e 100644 --- a/src/materials/material_linear_elastic1.hh +++ b/src/materials/material_linear_elastic1.hh @@ -1,190 +1,194 @@ /** * @file material_linear_elastic1.hh * * @author Till Junge * * @date 13 Nov 2017 * * @brief Implementation for linear elastic reference material like in de Geus * 2017. This follows the simplest and likely not most efficient * implementation (with exception of the Python law) * * Copyright © 2017 Till Junge * * µSpectre 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, 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 Lesser General Public License * along with µSpectre; see the file COPYING. If not, write to the * Free Software Foundation, Inc., 59 Temple Place - Suite 330, * * Boston, MA 02111-1307, USA. * * Additional permission under GNU GPL version 3 section 7 * * If you modify this Program, or any covered work, by linking or combining it * with proprietary FFT implementations or numerical libraries, containing parts * covered by the terms of those libraries' licenses, the licensors of this * Program grant you additional permission to convey the resulting work. */ #ifndef SRC_MATERIALS_MATERIAL_LINEAR_ELASTIC1_HH_ #define SRC_MATERIALS_MATERIAL_LINEAR_ELASTIC1_HH_ #include "common/common.hh" #include "materials/material_muSpectre_base.hh" #include "materials/materials_toolbox.hh" namespace muSpectre { - template class MaterialLinearElastic1; + template + class MaterialLinearElastic1; /** * traits for objective linear elasticity */ template struct MaterialMuSpectre_traits> { using Parent = MaterialMuSpectre_traits; //!< base for elasticity //! global field collection using GFieldCollection_t = typename MaterialBase::GFieldCollection_t; //! expected map type for strain fields using StrainMap_t = MatrixFieldMap; //! expected map type for stress fields using StressMap_t = MatrixFieldMap; //! expected map type for tangent stiffness fields using TangentMap_t = T4MatrixFieldMap; //! declare what type of strain measure your law takes as input constexpr static auto strain_measure{StrainMeasure::GreenLagrange}; //! declare what type of stress measure your law yields as output constexpr static auto stress_measure{StressMeasure::PK2}; //! elasticity without internal variables using InternalVariables = std::tuple<>; }; //! DimS spatial dimension (dimension of problem //! DimM material_dimension (dimension of constitutive law) /** * implements objective linear elasticity */ template class MaterialLinearElastic1 : public MaterialMuSpectre, DimS, DimM> { public: //! base class using Parent = MaterialMuSpectre; /** * type used to determine whether the * `muSpectre::MaterialMuSpectre::iterable_proxy` evaluate only * stresses or also tangent stiffnesses */ using NeedTangent = typename Parent::NeedTangent; //! global field collection using Stiffness_t = Eigen::TensorFixedSize>; //! traits of this material using traits = MaterialMuSpectre_traits; //! this law does not have any internal variables using InternalVariables = typename traits::InternalVariables; //! Hooke's law implementation using Hooke = typename MatTB::Hooke; //! Default constructor MaterialLinearElastic1() = delete; //! Copy constructor - MaterialLinearElastic1(const MaterialLinearElastic1 &other) = delete; + MaterialLinearElastic1(const MaterialLinearElastic1 & other) = delete; //! Construct by name, Young's modulus and Poisson's ratio MaterialLinearElastic1(std::string name, Real young, Real poisson); //! Move constructor - MaterialLinearElastic1(MaterialLinearElastic1 &&other) = delete; + MaterialLinearElastic1(MaterialLinearElastic1 && other) = delete; //! Destructor virtual ~MaterialLinearElastic1() = default; //! Copy assignment operator MaterialLinearElastic1 & - operator=(const MaterialLinearElastic1 &other) = delete; + operator=(const MaterialLinearElastic1 & other) = delete; //! Move assignment operator - MaterialLinearElastic1 &operator=(MaterialLinearElastic1 &&other) = delete; + MaterialLinearElastic1 & + operator=(MaterialLinearElastic1 && other) = delete; /** * evaluates second Piola-Kirchhoff stress given the Green-Lagrange * strain (or Cauchy stress if called with a small strain tensor) */ - template inline decltype(auto) evaluate_stress(s_t &&E); + template + inline decltype(auto) evaluate_stress(s_t && E); /** * evaluates both second Piola-Kirchhoff stress and stiffness given * the Green-Lagrange strain (or Cauchy stress and stiffness if * called with a small strain tensor) */ - template inline decltype(auto) evaluate_stress_tangent(s_t &&E); + template + inline decltype(auto) evaluate_stress_tangent(s_t && E); /** * return the empty internals tuple */ - InternalVariables &get_internals() { return this->internal_variables; } + InternalVariables & get_internals() { return this->internal_variables; } protected: const Real young; //!< Young's modulus const Real poisson; //!< Poisson's ratio const Real lambda; //!< first Lamé constant const Real mu; //!< second Lamé constant (shear modulus) const Stiffness_t C; //!< stiffness tensor //! empty tuple InternalVariables internal_variables{}; private: }; /* ---------------------------------------------------------------------- */ template template - auto MaterialLinearElastic1::evaluate_stress(s_t &&E) + auto MaterialLinearElastic1::evaluate_stress(s_t && E) -> decltype(auto) { return Hooke::evaluate_stress(this->lambda, this->mu, std::move(E)); } /* ---------------------------------------------------------------------- */ template template - auto MaterialLinearElastic1::evaluate_stress_tangent(s_t &&E) + auto MaterialLinearElastic1::evaluate_stress_tangent(s_t && E) -> decltype(auto) { using Tangent_t = typename traits::TangentMap_t::reference; // using mat = Eigen::Matrix; // mat ecopy{E}; // std::cout << "E" << std::endl << ecopy << std::endl; // std::cout << "P1" << std::endl << mat{ // std::get<0>(Hooke::evaluate_stress(this->lambda, this->mu, // Tangent_t(const_cast(this->C.data())), // std::move(E)))} << std::endl; return Hooke::evaluate_stress( this->lambda, this->mu, Tangent_t(const_cast(this->C.data())), std::move(E)); } } // namespace muSpectre #endif // SRC_MATERIALS_MATERIAL_LINEAR_ELASTIC1_HH_ diff --git a/src/materials/material_linear_elastic2.cc b/src/materials/material_linear_elastic2.cc index da15323..c05ddcb 100644 --- a/src/materials/material_linear_elastic2.cc +++ b/src/materials/material_linear_elastic2.cc @@ -1,70 +1,70 @@ /** * @file material_linear_elastic2.cc * * @author Till Junge * * @date 04 Feb 2018 * * @brief implementation for linear elastic material with eigenstrain * * Copyright © 2018 Till Junge * * µSpectre 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, 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 Lesser General Public License * along with µSpectre; see the file COPYING. If not, write to the * Free Software Foundation, Inc., 59 Temple Place - Suite 330, * * Boston, MA 02111-1307, USA. * * Additional permission under GNU GPL version 3 section 7 * * If you modify this Program, or any covered work, by linking or combining it * with proprietary FFT implementations or numerical libraries, containing parts * covered by the terms of those libraries' licenses, the licensors of this * Program grant you additional permission to convey the resulting work. */ #include "materials/material_linear_elastic2.hh" namespace muSpectre { /* ---------------------------------------------------------------------- */ template MaterialLinearElastic2::MaterialLinearElastic2(std::string name, Real young, Real poisson) : Parent{name}, material{name, young, poisson}, eigen_field{make_field("Eigenstrain", this->internal_fields)}, internal_variables(eigen_field.get_const_map()) {} /* ---------------------------------------------------------------------- */ template void MaterialLinearElastic2::add_pixel( const Ccoord_t & /*pixel*/) { throw std::runtime_error("this material needs pixels with and eigenstrain"); } /* ---------------------------------------------------------------------- */ template void - MaterialLinearElastic2::add_pixel(const Ccoord_t &pixel, - const StrainTensor &E_eig) { + MaterialLinearElastic2::add_pixel(const Ccoord_t & pixel, + const StrainTensor & E_eig) { this->internal_fields.add_pixel(pixel); Eigen::Map> strain_array( E_eig.data()); this->eigen_field.push_back(strain_array); } template class MaterialLinearElastic2; template class MaterialLinearElastic2; template class MaterialLinearElastic2; } // namespace muSpectre diff --git a/src/materials/material_linear_elastic2.hh b/src/materials/material_linear_elastic2.hh index ed8bb0a..319ce2d 100644 --- a/src/materials/material_linear_elastic2.hh +++ b/src/materials/material_linear_elastic2.hh @@ -1,201 +1,203 @@ /** * @file material_linear_elastic2.hh * * @author Till Junge * * @date 03 Feb 2018 * * @brief linear elastic material with imposed eigenstrain and its * type traits. Uses the MaterialMuSpectre facilities to keep it * simple * * Copyright © 2018 Till Junge * * µSpectre 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, 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 Lesser General Public License * along with µSpectre; see the file COPYING. If not, write to the * Free Software Foundation, Inc., 59 Temple Place - Suite 330, * * Boston, MA 02111-1307, USA. * * Additional permission under GNU GPL version 3 section 7 * * If you modify this Program, or any covered work, by linking or combining it * with proprietary FFT implementations or numerical libraries, containing parts * covered by the terms of those libraries' licenses, the licensors of this * Program grant you additional permission to convey the resulting work. */ #ifndef SRC_MATERIALS_MATERIAL_LINEAR_ELASTIC2_HH_ #define SRC_MATERIALS_MATERIAL_LINEAR_ELASTIC2_HH_ #include "materials/material_linear_elastic1.hh" #include "common/field.hh" #include namespace muSpectre { - template class MaterialLinearElastic2; + template + class MaterialLinearElastic2; /** * traits for objective linear elasticity with eigenstrain */ template struct MaterialMuSpectre_traits> { //! global field collection using GFieldCollection_t = typename MaterialBase::GFieldCollection_t; //! expected map type for strain fields using StrainMap_t = MatrixFieldMap; //! expected map type for stress fields using StressMap_t = MatrixFieldMap; //! expected map type for tangent stiffness fields using TangentMap_t = T4MatrixFieldMap; //! declare what type of strain measure your law takes as input constexpr static auto strain_measure{StrainMeasure::GreenLagrange}; //! declare what type of stress measure your law yields as output constexpr static auto stress_measure{StressMeasure::PK2}; //! local field_collections used for internals using LFieldColl_t = LocalFieldCollection; //! local strain type using LStrainMap_t = MatrixFieldMap; //! elasticity with eigenstrain using InternalVariables = std::tuple; }; /** * implements objective linear elasticity with an eigenstrain per pixel */ template class MaterialLinearElastic2 : public MaterialMuSpectre, DimS, DimM> { public: //! base class using Parent = MaterialMuSpectre; //! type for stiffness tensor construction using Stiffness_t = Eigen::TensorFixedSize>; //! traits of this material using traits = MaterialMuSpectre_traits; //! Type of container used for storing eigenstrain using InternalVariables = typename traits::InternalVariables; //! Hooke's law implementation using Hooke = typename MatTB::Hooke; //! reference to any type that casts to a matrix using StrainTensor = Eigen::Ref>; //! Default constructor MaterialLinearElastic2() = delete; //! Construct by name, Young's modulus and Poisson's ratio MaterialLinearElastic2(std::string name, Real young, Real poisson); //! Copy constructor - MaterialLinearElastic2(const MaterialLinearElastic2 &other) = delete; + MaterialLinearElastic2(const MaterialLinearElastic2 & other) = delete; //! Move constructor - MaterialLinearElastic2(MaterialLinearElastic2 &&other) = delete; + MaterialLinearElastic2(MaterialLinearElastic2 && other) = delete; //! Destructor virtual ~MaterialLinearElastic2() = default; //! Copy assignment operator MaterialLinearElastic2 & - operator=(const MaterialLinearElastic2 &other) = delete; + operator=(const MaterialLinearElastic2 & other) = delete; //! Move assignment operator - MaterialLinearElastic2 &operator=(MaterialLinearElastic2 &&other) = delete; + MaterialLinearElastic2 & + operator=(MaterialLinearElastic2 && other) = delete; /** * evaluates second Piola-Kirchhoff stress given the Green-Lagrange * strain (or Cauchy stress if called with a small strain tensor) */ template - inline decltype(auto) evaluate_stress(s_t &&E, eigen_s_t &&E_eig); + inline decltype(auto) evaluate_stress(s_t && E, eigen_s_t && E_eig); /** * evaluates both second Piola-Kirchhoff stress and stiffness given * the Green-Lagrange strain (or Cauchy stress and stiffness if * called with a small strain tensor) */ template - inline decltype(auto) evaluate_stress_tangent(s_t &&E, eigen_s_t &&E_eig); + inline decltype(auto) evaluate_stress_tangent(s_t && E, eigen_s_t && E_eig); /** * return the internals tuple */ - InternalVariables &get_internals() { return this->internal_variables; } + InternalVariables & get_internals() { return this->internal_variables; } /** * overload add_pixel to write into eigenstrain */ - void add_pixel(const Ccoord_t &pixel) final; + void add_pixel(const Ccoord_t & pixel) final; /** * overload add_pixel to write into eigenstrain */ - void add_pixel(const Ccoord_t &pixel, const StrainTensor &E_eig); + void add_pixel(const Ccoord_t & pixel, const StrainTensor & E_eig); protected: //! linear material without eigenstrain used to compute response MaterialLinearElastic1 material; //! storage for eigenstrain using Field_t = TensorField, Real, secondOrder, DimM>; - Field_t &eigen_field; //!< field holding the eigen strain per pixel + Field_t & eigen_field; //!< field holding the eigen strain per pixel //! tuple for iterable eigen_field InternalVariables internal_variables; private: }; /* ---------------------------------------------------------------------- */ template template - auto MaterialLinearElastic2::evaluate_stress(s_t &&E, - eigen_s_t &&E_eig) + auto MaterialLinearElastic2::evaluate_stress(s_t && E, + eigen_s_t && E_eig) -> decltype(auto) { return this->material.evaluate_stress(E - E_eig); } /* ---------------------------------------------------------------------- */ template template auto MaterialLinearElastic2::evaluate_stress_tangent( - s_t &&E, eigen_s_t &&E_eig) -> decltype(auto) { + s_t && E, eigen_s_t && E_eig) -> decltype(auto) { // using mat = Eigen::Matrix; // mat ecopy{E}; // mat eig_copy{E_eig}; // mat ediff{ecopy-eig_copy}; // std::cout << "eidff - (E-E_eig)" << std::endl << ediff-(E-E_eig) << // std::endl; std::cout << "P1 " << std::endl << // mat{std::get<0>(this->material.evaluate_stress_tangent(E-E_eig))} << // "" << std::endl; std::cout << "P2" << std::endl << // mat{std::get<0>(this->material.evaluate_stress_tangent(std::move(ediff)))} // << std::endl; return this->material.evaluate_stress_tangent(E - E_eig); } } // namespace muSpectre #endif // SRC_MATERIALS_MATERIAL_LINEAR_ELASTIC2_HH_ diff --git a/src/materials/material_linear_elastic3.cc b/src/materials/material_linear_elastic3.cc index 1210c2e..6349c46 100644 --- a/src/materials/material_linear_elastic3.cc +++ b/src/materials/material_linear_elastic3.cc @@ -1,73 +1,73 @@ /** * @file material_linear_elastic3.cc * * @author Richard Leute MaterialLinearElastic3::MaterialLinearElastic3(std::string name) : Parent{name}, C_field{make_field("local stiffness tensor", this->internal_fields)}, internal_variables(C_field.get_const_map()) {} /* ---------------------------------------------------------------------- */ template void MaterialLinearElastic3::add_pixel( const Ccoord_t & /*pixel*/) { throw std::runtime_error( "this material needs pixels with Youngs modulus and Poisson ratio."); } /* ---------------------------------------------------------------------- */ template void MaterialLinearElastic3::add_pixel( - const Ccoord_t &pixel, const Real &Young, const Real &Poisson) { + const Ccoord_t & pixel, const Real & Young, const Real & Poisson) { this->internal_fields.add_pixel(pixel); Real lambda = Hooke::compute_lambda(Young, Poisson); Real mu = Hooke::compute_mu(Young, Poisson); auto C_tensor = Hooke::compute_C(lambda, mu); Eigen::Map> C( C_tensor.data()); this->C_field.push_back(C); } template class MaterialLinearElastic3; template class MaterialLinearElastic3; template class MaterialLinearElastic3; } // namespace muSpectre diff --git a/src/materials/material_linear_elastic3.hh b/src/materials/material_linear_elastic3.hh index f8da328..f68e556 100644 --- a/src/materials/material_linear_elastic3.hh +++ b/src/materials/material_linear_elastic3.hh @@ -1,195 +1,197 @@ /** * @file material_linear_elastic3.hh * * @author Richard Leute * * @date 20 Feb 2018 * * @brief linear elastic material with distribution of stiffness properties. * Uses the MaterialMuSpectre facilities to keep it simple. * * Copyright © 2018 Till Junge * * µSpectre 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, 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 Lesser General Public License * along with µSpectre; see the file COPYING. If not, write to the * Free Software Foundation, Inc., 59 Temple Place - Suite 330, * * Boston, MA 02111-1307, USA. * * Additional permission under GNU GPL version 3 section 7 * * If you modify this Program, or any covered work, by linking or combining it * with proprietary FFT implementations or numerical libraries, containing parts * covered by the terms of those libraries' licenses, the licensors of this * Program grant you additional permission to convey the resulting work. */ #ifndef SRC_MATERIALS_MATERIAL_LINEAR_ELASTIC3_HH_ #define SRC_MATERIALS_MATERIAL_LINEAR_ELASTIC3_HH_ #include "materials/material_linear_elastic1.hh" #include "common/field.hh" #include "common/tensor_algebra.hh" #include namespace muSpectre { - template class MaterialLinearElastic3; + template + class MaterialLinearElastic3; /** * traits for objective linear elasticity with eigenstrain */ template struct MaterialMuSpectre_traits> { //! global field collection using GFieldCollection_t = typename MaterialBase::GFieldCollection_t; //! expected map type for strain fields using StrainMap_t = MatrixFieldMap; //! expected map type for stress fields using StressMap_t = MatrixFieldMap; //! expected map type for tangent stiffness fields using TangentMap_t = T4MatrixFieldMap; //! declare what type of strain measure your law takes as input constexpr static auto strain_measure{StrainMeasure::GreenLagrange}; //! declare what type of stress measure your law yields as output constexpr static auto stress_measure{StressMeasure::PK2}; //! local field_collections used for internals using LFieldColl_t = LocalFieldCollection; //! local stiffness tensor type using LStiffnessMap_t = T4MatrixFieldMap; //! elasticity without internal variables using InternalVariables = std::tuple; }; /** * implements objective linear elasticity with an eigenstrain per pixel */ template class MaterialLinearElastic3 : public MaterialMuSpectre, DimS, DimM> { public: //! base class using Parent = MaterialMuSpectre; /** * type used to determine whether the * `muSpectre::MaterialMuSpectre::iterable_proxy` evaluate only * stresses or also tangent stiffnesses */ using NeedTangent = typename Parent::NeedTangent; //! global field collection using Stiffness_t = Eigen::TensorFixedSize>; //! traits of this material using traits = MaterialMuSpectre_traits; //! Type of container used for storing eigenstrain using InternalVariables = typename traits::InternalVariables; //! Hooke's law implementation using Hooke = typename MatTB::Hooke; //! Default constructor MaterialLinearElastic3() = delete; //! Construct by name explicit MaterialLinearElastic3(std::string name); //! Copy constructor - MaterialLinearElastic3(const MaterialLinearElastic3 &other) = delete; + MaterialLinearElastic3(const MaterialLinearElastic3 & other) = delete; //! Move constructor - MaterialLinearElastic3(MaterialLinearElastic3 &&other) = delete; + MaterialLinearElastic3(MaterialLinearElastic3 && other) = delete; //! Destructor virtual ~MaterialLinearElastic3() = default; //! Copy assignment operator MaterialLinearElastic3 & - operator=(const MaterialLinearElastic3 &other) = delete; + operator=(const MaterialLinearElastic3 & other) = delete; //! Move assignment operator - MaterialLinearElastic3 &operator=(MaterialLinearElastic3 &&other) = delete; + MaterialLinearElastic3 & + operator=(MaterialLinearElastic3 && other) = delete; /** * evaluates second Piola-Kirchhoff stress given the Green-Lagrange * strain (or Cauchy stress if called with a small strain tensor) * and the local stiffness tensor. */ template - inline decltype(auto) evaluate_stress(s_t &&E, stiffness_t &&C); + inline decltype(auto) evaluate_stress(s_t && E, stiffness_t && C); /** * evaluates both second Piola-Kirchhoff stress and stiffness given * the Green-Lagrange strain (or Cauchy stress and stiffness if * called with a small strain tensor) and the local stiffness tensor. */ template - inline decltype(auto) evaluate_stress_tangent(s_t &&E, stiffness_t &&C); + inline decltype(auto) evaluate_stress_tangent(s_t && E, stiffness_t && C); /** * return the empty internals tuple */ - InternalVariables &get_internals() { return this->internal_variables; } + InternalVariables & get_internals() { return this->internal_variables; } /** * overload add_pixel to write into loacal stiffness tensor */ - void add_pixel(const Ccoord_t &pixel) final; + void add_pixel(const Ccoord_t & pixel) final; /** * overload add_pixel to write into local stiffness tensor */ - void add_pixel(const Ccoord_t &pixel, const Real &Young, - const Real &PoissonRatio); + void add_pixel(const Ccoord_t & pixel, const Real & Young, + const Real & PoissonRatio); protected: //! storage for stiffness tensor using Field_t = TensorField, Real, fourthOrder, DimM>; - Field_t &C_field; //!< field of stiffness tensors + Field_t & C_field; //!< field of stiffness tensors //! tuple for iterable eigen_field InternalVariables internal_variables; private: }; /* ---------------------------------------------------------------------- */ template template - auto MaterialLinearElastic3::evaluate_stress(s_t &&E, - stiffness_t &&C) + auto MaterialLinearElastic3::evaluate_stress(s_t && E, + stiffness_t && C) -> decltype(auto) { return Matrices::tensmult(C, E); } /* ---------------------------------------------------------------------- */ template template auto MaterialLinearElastic3::evaluate_stress_tangent( - s_t &&E, stiffness_t &&C) -> decltype(auto) { + s_t && E, stiffness_t && C) -> decltype(auto) { return std::make_tuple(evaluate_stress(E, C), C); } } // namespace muSpectre #endif // SRC_MATERIALS_MATERIAL_LINEAR_ELASTIC3_HH_ diff --git a/src/materials/material_linear_elastic4.cc b/src/materials/material_linear_elastic4.cc index f025b79..73be1db 100644 --- a/src/materials/material_linear_elastic4.cc +++ b/src/materials/material_linear_elastic4.cc @@ -1,79 +1,79 @@ /** * @file material_linear_elastic4.cc * * @author Richard Leute MaterialLinearElastic4::MaterialLinearElastic4(std::string name) : Parent{name}, lambda_field{make_field( "local first Lame constant", this->internal_fields)}, mu_field{ make_field("local second Lame constant(shear modulus)", this->internal_fields)}, internal_variables{lambda_field.get_const_map(), mu_field.get_const_map()} {} /* ---------------------------------------------------------------------- */ template void MaterialLinearElastic4::add_pixel( const Ccoord_t & /*pixel*/) { throw std::runtime_error( "this material needs pixels with Youngs modulus and Poisson ratio."); } /* ---------------------------------------------------------------------- */ template void - MaterialLinearElastic4::add_pixel(const Ccoord_t &pixel, - const Real &Young_modulus, - const Real &Poisson_ratio) { + MaterialLinearElastic4::add_pixel(const Ccoord_t & pixel, + const Real & Young_modulus, + const Real & Poisson_ratio) { this->internal_fields.add_pixel(pixel); // store the first(lambda) and second(mu) Lame constant in the field Real lambda = Hooke::compute_lambda(Young_modulus, Poisson_ratio); Real mu = Hooke::compute_mu(Young_modulus, Poisson_ratio); this->lambda_field.push_back(lambda); this->mu_field.push_back(mu); } template class MaterialLinearElastic4; template class MaterialLinearElastic4; template class MaterialLinearElastic4; } // namespace muSpectre diff --git a/src/materials/material_linear_elastic4.hh b/src/materials/material_linear_elastic4.hh index c40fda3..d9ae9e8 100644 --- a/src/materials/material_linear_elastic4.hh +++ b/src/materials/material_linear_elastic4.hh @@ -1,205 +1,207 @@ /** * @file material_linear_elastic4.hh * * @author Richard Leute * * @date 15 March 2018 * * @brief linear elastic material with distribution of stiffness properties. * In difference to material_linear_elastic3 two Lame constants are * stored per pixel instead of the whole elastic matrix C. * Uses the MaterialMuSpectre facilities to keep it simple. * * Copyright © 2018 Till Junge * * µSpectre 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, 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 Lesser General Public License * along with µSpectre; see the file COPYING. If not, write to the * Free Software Foundation, Inc., 59 Temple Place - Suite 330, * * Boston, MA 02111-1307, USA. * * Additional permission under GNU GPL version 3 section 7 * * If you modify this Program, or any covered work, by linking or combining it * with proprietary FFT implementations or numerical libraries, containing parts * covered by the terms of those libraries' licenses, the licensors of this * Program grant you additional permission to convey the resulting work. */ #ifndef SRC_MATERIALS_MATERIAL_LINEAR_ELASTIC4_HH_ #define SRC_MATERIALS_MATERIAL_LINEAR_ELASTIC4_HH_ #include "materials/material_linear_elastic1.hh" #include "common/field.hh" #include "common/tensor_algebra.hh" #include namespace muSpectre { - template class MaterialLinearElastic4; + template + class MaterialLinearElastic4; /** * traits for objective linear elasticity with eigenstrain */ template struct MaterialMuSpectre_traits> { //! global field collection using GFieldCollection_t = typename MaterialBase::GFieldCollection_t; //! expected map type for strain fields using StrainMap_t = MatrixFieldMap; //! expected map type for stress fields using StressMap_t = MatrixFieldMap; //! expected map type for tangent stiffness fields using TangentMap_t = T4MatrixFieldMap; //! declare what type of strain measure your law takes as input constexpr static auto strain_measure{StrainMeasure::GreenLagrange}; //! declare what type of stress measure your law yields as output constexpr static auto stress_measure{StressMeasure::PK2}; //! local field_collections used for internals using LFieldColl_t = LocalFieldCollection; //! local Lame constant type using LLameConstantMap_t = ScalarFieldMap; //! elasticity without internal variables using InternalVariables = std::tuple; }; /** * implements objective linear elasticity with an eigenstrain per pixel */ template class MaterialLinearElastic4 : public MaterialMuSpectre, DimS, DimM> { public: //! base class using Parent = MaterialMuSpectre; /** * type used to determine whether the * `muSpectre::MaterialMuSpectre::iterable_proxy` evaluate only * stresses or also tangent stiffnesses */ using NeedTangent = typename Parent::NeedTangent; //! global field collection using Stiffness_t = Eigen::TensorFixedSize>; //! traits of this material using traits = MaterialMuSpectre_traits; //! Type of container used for storing eigenstrain using InternalVariables = typename traits::InternalVariables; //! Hooke's law implementation using Hooke = typename MatTB::Hooke; //! Default constructor MaterialLinearElastic4() = delete; //! Construct by name explicit MaterialLinearElastic4(std::string name); //! Copy constructor - MaterialLinearElastic4(const MaterialLinearElastic4 &other) = delete; + MaterialLinearElastic4(const MaterialLinearElastic4 & other) = delete; //! Move constructor - MaterialLinearElastic4(MaterialLinearElastic4 &&other) = delete; + MaterialLinearElastic4(MaterialLinearElastic4 && other) = delete; //! Destructor virtual ~MaterialLinearElastic4() = default; //! Copy assignment operator MaterialLinearElastic4 & - operator=(const MaterialLinearElastic4 &other) = delete; + operator=(const MaterialLinearElastic4 & other) = delete; //! Move assignment operator - MaterialLinearElastic4 &operator=(MaterialLinearElastic4 &&other) = delete; + MaterialLinearElastic4 & + operator=(MaterialLinearElastic4 && other) = delete; /** * evaluates second Piola-Kirchhoff stress given the Green-Lagrange * strain (or Cauchy stress if called with a small strain tensor), the first * Lame constant (lambda) and the second Lame constant (shear modulus/mu). */ template - inline decltype(auto) evaluate_stress(s_t &&E, const Real &lambda, - const Real &mu); + inline decltype(auto) evaluate_stress(s_t && E, const Real & lambda, + const Real & mu); /** * evaluates both second Piola-Kirchhoff stress and stiffness given * the Green-Lagrange strain (or Cauchy stress and stiffness if * called with a small strain tensor), the first Lame constant (lambda) and * the second Lame constant (shear modulus/mu). */ template - inline decltype(auto) evaluate_stress_tangent(s_t &&E, const Real &lambda, - const Real &mu); + inline decltype(auto) evaluate_stress_tangent(s_t && E, const Real & lambda, + const Real & mu); /** * return the empty internals tuple */ - InternalVariables &get_internals() { return this->internal_variables; } + InternalVariables & get_internals() { return this->internal_variables; } /** * overload add_pixel to write into loacal stiffness tensor */ - void add_pixel(const Ccoord_t &pixel) final; + void add_pixel(const Ccoord_t & pixel) final; /** * overload add_pixel to write into local stiffness tensor */ - void add_pixel(const Ccoord_t &pixel, const Real &Poisson_ratio, - const Real &Youngs_modulus); + void add_pixel(const Ccoord_t & pixel, const Real & Poisson_ratio, + const Real & Youngs_modulus); protected: //! storage for first Lame constant 'lambda' //! and second Lame constant(shear modulus) 'mu' using Field_t = MatrixField, Real, oneD, oneD>; - Field_t &lambda_field; - Field_t &mu_field; + Field_t & lambda_field; + Field_t & mu_field; //! tuple for iterable eigen_field InternalVariables internal_variables; private: }; /* ---------------------------------------------------------------------- */ template template - auto MaterialLinearElastic4::evaluate_stress(s_t &&E, - const Real &lambda, - const Real &mu) + auto MaterialLinearElastic4::evaluate_stress(s_t && E, + const Real & lambda, + const Real & mu) -> decltype(auto) { auto C = Hooke::compute_C_T4(lambda, mu); return Matrices::tensmult(C, E); } /* ---------------------------------------------------------------------- */ template template auto MaterialLinearElastic4::evaluate_stress_tangent( - s_t &&E, const Real &lambda, const Real &mu) -> decltype(auto) { + s_t && E, const Real & lambda, const Real & mu) -> decltype(auto) { auto C = Hooke::compute_C_T4(lambda, mu); return std::make_tuple(Matrices::tensmult(C, E), C); } } // namespace muSpectre #endif // SRC_MATERIALS_MATERIAL_LINEAR_ELASTIC4_HH_ diff --git a/src/materials/material_linear_elastic_generic.cc b/src/materials/material_linear_elastic_generic.cc index 06560ac..54390f4 100644 --- a/src/materials/material_linear_elastic_generic.cc +++ b/src/materials/material_linear_elastic_generic.cc @@ -1,71 +1,71 @@ /** * @file material_linear_elastic_generic.cc * * @author Till Junge * * @date 21 Sep 2018 * * @brief implementation for MaterialLinearElasticGeneric * * Copyright © 2018 Till Junge * * µSpectre 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, 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 Lesser General Public License * along with µSpectre; see the file COPYING. If not, write to the * Free Software Foundation, Inc., 59 Temple Place - Suite 330, * * Boston, MA 02111-1307, USA. * * Additional permission under GNU GPL version 3 section 7 * * If you modify this Program, or any covered work, by linking or combining it * with proprietary FFT implementations or numerical libraries, containing parts * covered by the terms of those libraries' licenses, the licensors of this * Program grant you additional permission to convey the resulting work. */ #include "materials/material_linear_elastic_generic.hh" #include "common/voigt_conversion.hh" namespace muSpectre { /* ---------------------------------------------------------------------- */ template MaterialLinearElasticGeneric::MaterialLinearElasticGeneric( - const std::string &name, const CInput_t &C_voigt) + const std::string & name, const CInput_t & C_voigt) : Parent{name} { using VC_t = VoigtConversion; constexpr Dim_t VSize{vsize(DimM)}; if (not(C_voigt.rows() == VSize) or not(C_voigt.cols() == VSize)) { std::stringstream err_str{}; err_str << "The stiffness tensor should be input as a " << VSize << " × " << VSize << " Matrix in Voigt notation. You supplied" << " a " << C_voigt.rows() << " × " << C_voigt.cols() << " matrix"; } for (int i{0}; i < DimM; ++i) { for (int j{0}; j < DimM; ++j) { for (int k{0}; k < DimM; ++k) { for (int l{0}; l < DimM; ++l) { get(this->C, i, j, k, l) = C_voigt(VC_t::sym_mat(i, j), VC_t::sym_mat(k, l)); } } } } } template class MaterialLinearElasticGeneric; template class MaterialLinearElasticGeneric; template class MaterialLinearElasticGeneric; } // namespace muSpectre diff --git a/src/materials/material_linear_elastic_generic.hh b/src/materials/material_linear_elastic_generic.hh index 7716512..31b078a 100644 --- a/src/materials/material_linear_elastic_generic.hh +++ b/src/materials/material_linear_elastic_generic.hh @@ -1,184 +1,187 @@ /** * @file material_linear_elastic_generic.hh * * @author Till Junge * * @date 21 Sep 2018 * * @brief Implementation fo a generic linear elastic material that * stores the full elastic stiffness tensor. Convenient but not the * most efficient * * Copyright © 2018 Till Junge * * µSpectre 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, 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 Lesser General Public License * along with µSpectre; see the file COPYING. If not, write to the * Free Software Foundation, Inc., 59 Temple Place - Suite 330, * * Boston, MA 02111-1307, USA. * * Additional permission under GNU GPL version 3 section 7 * * If you modify this Program, or any covered work, by linking or combining it * with proprietary FFT implementations or numerical libraries, containing parts * covered by the terms of those libraries' licenses, the licensors of this * Program grant you additional permission to convey the resulting work. */ #ifndef SRC_MATERIALS_MATERIAL_LINEAR_ELASTIC_GENERIC_HH_ #define SRC_MATERIALS_MATERIAL_LINEAR_ELASTIC_GENERIC_HH_ #include "common/common.hh" #include "common/T4_map_proxy.hh" #include "materials/material_muSpectre_base.hh" #include "common/tensor_algebra.hh" namespace muSpectre { /** * forward declaration */ - template class MaterialLinearElasticGeneric; + template + class MaterialLinearElasticGeneric; /** * traits for use by MaterialMuSpectre for crtp */ template struct MaterialMuSpectre_traits> { //! global field collection using GFieldCollection_t = typename MaterialBase::GFieldCollection_t; //! expected map type for strain fields using StrainMap_t = MatrixFieldMap; //! expected map type for stress fields using StressMap_t = MatrixFieldMap; //! expected map type for tangent stiffness fields using TangentMap_t = T4MatrixFieldMap; //! declare what type of strain measure your law takes as input constexpr static auto strain_measure{StrainMeasure::GreenLagrange}; //! declare what type of stress measure your law yields as output constexpr static auto stress_measure{StressMeasure::PK2}; //! elasticity without internal variables using InternalVariables = std::tuple<>; }; /** * Linear elastic law defined by a full stiffness tensor. Very * generic, but not most efficient */ template class MaterialLinearElasticGeneric : public MaterialMuSpectre, DimS, DimM> { public: //! parent type using Parent = MaterialMuSpectre, DimS, DimM>; //! generic input tolerant to python input using CInput_t = Eigen::Ref, 0, Eigen::Stride>; //! Default constructor MaterialLinearElasticGeneric() = delete; /** * Constructor by name and stiffness tensor. * * @param name unique material name * @param C_voigt elastic tensor in Voigt notation */ - MaterialLinearElasticGeneric(const std::string &name, - const CInput_t &C_voigt); + MaterialLinearElasticGeneric(const std::string & name, + const CInput_t & C_voigt); //! Copy constructor - MaterialLinearElasticGeneric(const MaterialLinearElasticGeneric &other) = + MaterialLinearElasticGeneric(const MaterialLinearElasticGeneric & other) = delete; //! Move constructor - MaterialLinearElasticGeneric(MaterialLinearElasticGeneric &&other) = delete; + MaterialLinearElasticGeneric(MaterialLinearElasticGeneric && other) = + delete; //! Destructor virtual ~MaterialLinearElasticGeneric() = default; //! Copy assignment operator MaterialLinearElasticGeneric & - operator=(const MaterialLinearElasticGeneric &other) = delete; + operator=(const MaterialLinearElasticGeneric & other) = delete; //! Move assignment operator MaterialLinearElasticGeneric & - operator=(MaterialLinearElasticGeneric &&other) = delete; + operator=(MaterialLinearElasticGeneric && other) = delete; //! see //! http://eigen.tuxfamily.org/dox/group__TopicStructHavingEigenMembers.html EIGEN_MAKE_ALIGNED_OPERATOR_NEW; /** * evaluates second Piola-Kirchhoff stress given the Green-Lagrange * strain (or Cauchy stress if called with a small strain tensor) */ template - inline decltype(auto) evaluate_stress(const Eigen::MatrixBase &E); + inline decltype(auto) evaluate_stress(const Eigen::MatrixBase & E); /** * evaluates both second Piola-Kirchhoff stress and stiffness given * the Green-Lagrange strain (or Cauchy stress and stiffness if * called with a small strain tensor) */ - template inline decltype(auto) evaluate_stress_tangent(s_t &&E); + template + inline decltype(auto) evaluate_stress_tangent(s_t && E); /** * return the empty internals tuple */ - std::tuple<> &get_internals() { return this->internal_variables; } + std::tuple<> & get_internals() { return this->internal_variables; } /** * return a reference to teh stiffness tensor */ - const T4Mat &get_C() const { return this->C; } + const T4Mat & get_C() const { return this->C; } protected: T4Mat C{}; //! empty tuple std::tuple<> internal_variables{}; private: }; /* ---------------------------------------------------------------------- */ template template auto MaterialLinearElasticGeneric::evaluate_stress( - const Eigen::MatrixBase &E) -> decltype(auto) { + const Eigen::MatrixBase & E) -> decltype(auto) { static_assert(Derived::ColsAtCompileTime == DimM, "wrong input size"); static_assert(Derived::RowsAtCompileTime == DimM, "wrong input size"); return Matrices::tensmult(this->C, E); } /* ---------------------------------------------------------------------- */ template template auto - MaterialLinearElasticGeneric::evaluate_stress_tangent(s_t &&E) + MaterialLinearElasticGeneric::evaluate_stress_tangent(s_t && E) -> decltype(auto) { using Stress_t = decltype(this->evaluate_stress(std::forward(E))); using Stiffness_t = Eigen::Map>; using Ret_t = std::tuple; return Ret_t{this->evaluate_stress(std::forward(E)), Stiffness_t(this->C.data())}; } } // namespace muSpectre #endif // SRC_MATERIALS_MATERIAL_LINEAR_ELASTIC_GENERIC_HH_ diff --git a/src/materials/material_muSpectre_base.hh b/src/materials/material_muSpectre_base.hh index febce4c..2d903d3 100644 --- a/src/materials/material_muSpectre_base.hh +++ b/src/materials/material_muSpectre_base.hh @@ -1,698 +1,701 @@ /** * @file material_muSpectre_base.hh * * @author Till Junge * * @date 25 Oct 2017 * * @brief Base class for materials written for µSpectre specifically. These * can take full advantage of the configuration-change utilities of * µSpectre. The user can inherit from them to define new constitutive * laws and is merely required to provide the methods for computing the * second Piola-Kirchhoff stress and Tangent. This class uses the * "curiously recurring template parameter" to avoid virtual calls. * * Copyright © 2017 Till Junge * * µSpectre 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, 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 Lesser General Public License * along with µSpectre; see the file COPYING. If not, write to the * Free Software Foundation, Inc., 59 Temple Place - Suite 330, * * Boston, MA 02111-1307, USA. * * Additional permission under GNU GPL version 3 section 7 * * If you modify this Program, or any covered work, by linking or combining it * with proprietary FFT implementations or numerical libraries, containing parts * covered by the terms of those libraries' licenses, the licensors of this * Program grant you additional permission to convey the resulting work. */ #ifndef SRC_MATERIALS_MATERIAL_MUSPECTRE_BASE_HH_ #define SRC_MATERIALS_MATERIAL_MUSPECTRE_BASE_HH_ #include "common/common.hh" #include "materials/material_base.hh" #include "materials/materials_toolbox.hh" #include "common/field_collection.hh" #include "common/field.hh" #include "common//utilities.hh" #include #include #include #include namespace muSpectre { // Forward declaration for factory function - template class CellBase; + template + class CellBase; /** * material traits are used by `muSpectre::MaterialMuSpectre` to * break the circular dependence created by the curiously recurring * template parameter. These traits must define * - these `muSpectre::FieldMap`s: * - `StrainMap_t`: typically a `muSpectre::MatrixFieldMap` for a * constant second-order `muSpectre::TensorField` * - `StressMap_t`: typically a `muSpectre::MatrixFieldMap` for a * writable secord-order `muSpectre::TensorField` * - `TangentMap_t`: typically a `muSpectre::T4MatrixFieldMap` for a * writable fourth-order `muSpectre::TensorField` * - `strain_measure`: the expected strain type (will be replaced by the * small-strain tensor ε * `muspectre::StrainMeasure::Infinitesimal` in small * strain computations) * - `stress_measure`: the measure of the returned stress. Is used by * `muspectre::MaterialMuSpectre` to transform it into * Cauchy stress (`muspectre::StressMeasure::Cauchy`) in * small-strain computations and into first * Piola-Kirchhoff stress `muspectre::StressMeasure::PK1` * in finite-strain computations * - `InternalVariables`: a tuple of `muSpectre::FieldMap`s containing * internal variables */ - template struct MaterialMuSpectre_traits {}; + template + struct MaterialMuSpectre_traits {}; - template class MaterialMuSpectre; + template + class MaterialMuSpectre; /** * Base class for most convenient implementation of materials */ template class MaterialMuSpectre : public MaterialBase { public: /** * type used to determine whether the * `muSpectre::MaterialMuSpectre::iterable_proxy` evaluate only * stresses or also tangent stiffnesses */ using NeedTangent = MatTB::NeedTangent; using Parent = MaterialBase; //!< base class //! global field collection using GFieldCollection_t = typename Parent::GFieldCollection_t; //! expected type for stress fields using StressField_t = typename Parent::StressField_t; //! expected type for strain fields using StrainField_t = typename Parent::StrainField_t; //! expected type for tangent stiffness fields using TangentField_t = typename Parent::TangentField_t; //! traits for the CRTP subclass using traits = MaterialMuSpectre_traits; //! Default constructor MaterialMuSpectre() = delete; //! Construct by name explicit MaterialMuSpectre(std::string name); //! Copy constructor - MaterialMuSpectre(const MaterialMuSpectre &other) = delete; + MaterialMuSpectre(const MaterialMuSpectre & other) = delete; //! Move constructor - MaterialMuSpectre(MaterialMuSpectre &&other) = delete; + MaterialMuSpectre(MaterialMuSpectre && other) = delete; //! Destructor virtual ~MaterialMuSpectre() = default; //! Factory template - static Material &make(CellBase &cell, - ConstructorArgs &&... args); + static Material & make(CellBase & cell, + ConstructorArgs &&... args); //! Copy assignment operator - MaterialMuSpectre &operator=(const MaterialMuSpectre &other) = delete; + MaterialMuSpectre & operator=(const MaterialMuSpectre & other) = delete; //! Move assignment operator - MaterialMuSpectre &operator=(MaterialMuSpectre &&other) = delete; + MaterialMuSpectre & operator=(MaterialMuSpectre && other) = delete; //! allocate memory, etc void initialise() override; using Parent::compute_stresses; using Parent::compute_stresses_tangent; //! computes stress - void compute_stresses(const StrainField_t &F, StressField_t &P, + void compute_stresses(const StrainField_t & F, StressField_t & P, Formulation form) final; //! computes stress and tangent modulus - void compute_stresses_tangent(const StrainField_t &F, - StressField_t &P, TangentField_t &K, - Formulation form) final; + void compute_stresses_tangent(const StrainField_t & F, StressField_t & P, + TangentField_t & K, Formulation form) final; protected: //! computes stress with the formulation available at compile time //! __attribute__ required by g++-6 and g++-7 because of this bug: //! https://gcc.gnu.org/bugzilla/show_bug.cgi?id=80947 template - inline void compute_stresses_worker(const StrainField_t &F, - StressField_t &P) + inline void compute_stresses_worker(const StrainField_t & F, + StressField_t & P) __attribute__((visibility("default"))); //! computes stress with the formulation available at compile time //! __attribute__ required by g++-6 and g++-7 because of this bug: //! https://gcc.gnu.org/bugzilla/show_bug.cgi?id=80947 template - inline void compute_stresses_worker(const StrainField_t &F, - StressField_t &P, TangentField_t &K) + inline void compute_stresses_worker(const StrainField_t & F, + StressField_t & P, TangentField_t & K) __attribute__((visibility("default"))); //! this iterable class is a default for simple laws that just take a strain //! the iterable is just a templated wrapper to provide a range to iterate //! over that does or does not include tangent moduli - template class iterable_proxy; + template + class iterable_proxy; /** * inheriting classes with internal variables need to overload this function */ - typename traits::InternalVariables &get_internals() { + typename traits::InternalVariables & get_internals() { return static_cast(*this).get_internals(); } bool is_initialised{false}; //!< to handle double initialisation right private: }; /* ---------------------------------------------------------------------- */ template MaterialMuSpectre::MaterialMuSpectre(std::string name) : Parent(name) { using stress_compatible = typename traits::StressMap_t::template is_compatible; using strain_compatible = typename traits::StrainMap_t::template is_compatible; using tangent_compatible = typename traits::TangentMap_t::template is_compatible; static_assert((stress_compatible::value && stress_compatible::explain()), "The material's declared stress map is not compatible " "with the stress field. More info in previously shown " "assert."); static_assert((strain_compatible::value && strain_compatible::explain()), "The material's declared strain map is not compatible " "with the strain field. More info in previously shown " "assert."); static_assert((tangent_compatible::value && tangent_compatible::explain()), "The material's declared tangent map is not compatible " "with the tangent field. More info in previously shown " "assert."); } /* ---------------------------------------------------------------------- */ template template Material & - MaterialMuSpectre::make(CellBase &cell, + MaterialMuSpectre::make(CellBase & cell, ConstructorArgs &&... args) { auto mat = std::make_unique(args...); - auto &mat_ref = *mat; + auto & mat_ref = *mat; cell.add_material(std::move(mat)); return mat_ref; } /* ---------------------------------------------------------------------- */ template void MaterialMuSpectre::initialise() { if (!this->is_initialised) { this->internal_fields.initialise(); this->is_initialised = true; } } /* ---------------------------------------------------------------------- */ template void MaterialMuSpectre::compute_stresses( - const StrainField_t &F, StressField_t &P, Formulation form) { + const StrainField_t & F, StressField_t & P, Formulation form) { switch (form) { case Formulation::finite_strain: { this->template compute_stresses_worker(F, P); break; } case Formulation::small_strain: { this->template compute_stresses_worker(F, P); break; } default: throw std::runtime_error("Unknown formulation"); break; } } /* ---------------------------------------------------------------------- */ template void MaterialMuSpectre::compute_stresses_tangent( - const StrainField_t &F, StressField_t &P, TangentField_t &K, + const StrainField_t & F, StressField_t & P, TangentField_t & K, Formulation form) { switch (form) { case Formulation::finite_strain: { this->template compute_stresses_worker(F, P, K); break; } case Formulation::small_strain: { this->template compute_stresses_worker(F, P, K); break; } default: throw std::runtime_error("Unknown formulation"); break; } } /* ---------------------------------------------------------------------- */ template template void MaterialMuSpectre::compute_stresses_worker( - const StrainField_t &F, StressField_t &P, TangentField_t &K) { + const StrainField_t & F, StressField_t & P, TangentField_t & K) { /* These lambdas are executed for every integration point. F contains the transformation gradient for finite strain calculations and the infinitesimal strain tensor in small strain problems The internal_variables tuple contains whatever internal variables Material declared (e.g., eigenstrain, strain rate, etc.) */ using Strains_t = std::tuple; using Stresses_t = std::tuple; auto constitutive_law_small_strain = [this](Strains_t Strains, Stresses_t Stresses, - auto &&internal_variables) { + auto && internal_variables) { constexpr StrainMeasure stored_strain_m{get_stored_strain_type(Form)}; constexpr StrainMeasure expected_strain_m{ get_formulation_strain_type(Form, traits::strain_measure)}; - auto &this_mat = static_cast(*this); + auto & this_mat = static_cast(*this); // Transformation gradient is first in the strains tuple - auto &F = std::get<0>(Strains); - auto &&strain = + auto & F = std::get<0>(Strains); + auto && strain = MatTB::convert_strain(F); // return value contains a tuple of rvalue_refs to both stress and tangent // moduli Stresses = apply( [&strain, &this_mat](auto &&... internals) { return this_mat.evaluate_stress_tangent(std::move(strain), internals...); }, internal_variables); }; auto constitutive_law_finite_strain = [this](Strains_t Strains, Stresses_t Stresses, - auto &&internal_variables) { + auto && internal_variables) { constexpr StrainMeasure stored_strain_m{get_stored_strain_type(Form)}; constexpr StrainMeasure expected_strain_m{ get_formulation_strain_type(Form, traits::strain_measure)}; - auto &this_mat = static_cast(*this); + auto & this_mat = static_cast(*this); // Transformation gradient is first in the strains tuple - auto &grad = std::get<0>(Strains); - auto &&strain = + auto & grad = std::get<0>(Strains); + auto && strain = MatTB::convert_strain(grad); // TODO(junge): Figure this out: I can't std::move(internals...), // because if there are no internals, compilation fails with "no // matching function for call to ‘move()’'. These are tuples of // lvalue references, so it shouldn't be too bad, but still // irksome. // return value contains a tuple of rvalue_refs to both stress // and tangent moduli auto stress_tgt = apply( [&strain, &this_mat](auto &&... internals) { return this_mat.evaluate_stress_tangent(std::move(strain), internals...); }, internal_variables); - auto &stress = std::get<0>(stress_tgt); - auto &tangent = std::get<1>(stress_tgt); + auto & stress = std::get<0>(stress_tgt); + auto & tangent = std::get<1>(stress_tgt); Stresses = MatTB::PK1_stress( std::move(grad), std::move(stress), std::move(tangent)); }; iterable_proxy fields{*this, F, P, K}; - for (auto &&arglist : fields) { + for (auto && arglist : fields) { /** * arglist is a tuple of three tuples containing only Lvalue * references (see value_tye in the class definition of * iterable_proxy::iterator). Tuples contain strains, stresses * and internal variables, respectively, */ // auto && stress_tgt = std::get<0>(tuples); // auto && inputs = std::get<1>(tuples);TODO:clean this static_assert(std::is_same( std::get<0>(arglist)))>>::value, "Type mismatch for strain reference, check iterator " "value_type"); static_assert(std::is_same( std::get<1>(arglist)))>>::value, "Type mismatch for stress reference, check iterator" "value_type"); static_assert(std::is_same( std::get<1>(arglist)))>>::value, "Type mismatch for tangent reference, check iterator" "value_type"); switch (Form) { case Formulation::small_strain: { apply(constitutive_law_small_strain, std::move(arglist)); break; } case Formulation::finite_strain: { apply(constitutive_law_finite_strain, std::move(arglist)); break; } } } } /* ---------------------------------------------------------------------- */ template template void MaterialMuSpectre::compute_stresses_worker( - const StrainField_t &F, StressField_t &P) { + const StrainField_t & F, StressField_t & P) { /* These lambdas are executed for every integration point. F contains the transformation gradient for finite strain calculations and the infinitesimal strain tensor in small strain problems The internal_variables tuple contains whatever internal variables Material declared (e.g., eigenstrain, strain rate, etc.) */ using Strains_t = std::tuple; using Stresses_t = std::tuple; auto constitutive_law_small_strain = [this](Strains_t Strains, Stresses_t Stresses, - auto &&internal_variables) { + auto && internal_variables) { constexpr StrainMeasure stored_strain_m{get_stored_strain_type(Form)}; constexpr StrainMeasure expected_strain_m{ get_formulation_strain_type(Form, traits::strain_measure)}; - auto &this_mat = static_cast(*this); + auto & this_mat = static_cast(*this); // Transformation gradient is first in the strains tuple - auto &F = std::get<0>(Strains); - auto &&strain = + auto & F = std::get<0>(Strains); + auto && strain = MatTB::convert_strain(F); // return value contains a tuple of rvalue_refs to both stress and tangent // moduli - auto &sigma = std::get<0>(Stresses); + auto & sigma = std::get<0>(Stresses); sigma = apply( [&strain, &this_mat](auto &&... internals) { return this_mat.evaluate_stress(std::move(strain), internals...); }, internal_variables); }; auto constitutive_law_finite_strain = [this](Strains_t Strains, - Stresses_t &&Stresses, - auto &&internal_variables) { + Stresses_t && Stresses, + auto && internal_variables) { constexpr StrainMeasure stored_strain_m{get_stored_strain_type(Form)}; constexpr StrainMeasure expected_strain_m{ get_formulation_strain_type(Form, traits::strain_measure)}; - auto &this_mat = static_cast(*this); + auto & this_mat = static_cast(*this); // Transformation gradient is first in the strains tuple - auto &F = std::get<0>(Strains); - auto &&strain = + auto & F = std::get<0>(Strains); + auto && strain = MatTB::convert_strain(F); // TODO(junge): Figure this out: I can't std::move(internals...), // because if there are no internals, compilation fails with "no // matching function for call to ‘move()’'. These are tuples of // lvalue references, so it shouldn't be too bad, but still // irksome. // return value contains a tuple of rvalue_refs to both stress // and tangent moduli - auto &&stress = apply( + auto && stress = apply( [&strain, &this_mat](auto &&... internals) { return this_mat.evaluate_stress(std::move(strain), internals...); }, internal_variables); - auto &P = get<0>(Stresses); + auto & P = get<0>(Stresses); P = MatTB::PK1_stress( F, stress); }; iterable_proxy fields{*this, F, P}; - for (auto &&arglist : fields) { + for (auto && arglist : fields) { /** * arglist is a tuple of three tuples containing only Lvalue * references (see value_tye in the class definition of * iterable_proxy::iterator). Tuples contain strains, stresses * and internal variables, respectively, */ // auto && stress_tgt = std::get<0>(tuples); // auto && inputs = std::get<1>(tuples);TODO:clean this static_assert(std::is_same( std::get<0>(arglist)))>>::value, "Type mismatch for strain reference, check iterator " "value_type"); static_assert(std::is_same( std::get<1>(arglist)))>>::value, "Type mismatch for stress reference, check iterator" "value_type"); switch (Form) { case Formulation::small_strain: { apply(constitutive_law_small_strain, std::move(arglist)); break; } case Formulation::finite_strain: { apply(constitutive_law_finite_strain, std::move(arglist)); break; } } } } /* ---------------------------------------------------------------------- */ //! this iterator class is a default for simple laws that just take a strain template template class MaterialMuSpectre::iterable_proxy { public: //! Default constructor iterable_proxy() = delete; /** * type used to determine whether the * `muSpectre::MaterialMuSpectre::iterable_proxy` evaluate only * stresses or also tangent stiffnesses */ using NeedTangent = typename MaterialMuSpectre::NeedTangent; /** Iterator uses the material's internal variables field collection to iterate selectively over the global fields (such as the transformation gradient F and first Piola-Kirchhoff stress P. **/ template - iterable_proxy(MaterialMuSpectre &mat, const StrainField_t &F, - StressField_t &P, - std::enable_if_t &K) + iterable_proxy(MaterialMuSpectre & mat, const StrainField_t & F, + StressField_t & P, + std::enable_if_t & K) : material{mat}, strain_field{F}, stress_tup{P, K}, internals{material.get_internals()} {}; /** Iterator uses the material's internal variables field collection to iterate selectively over the global fields (such as the transformation gradient F and first Piola-Kirchhoff stress P. **/ template - iterable_proxy(MaterialMuSpectre &mat, const StrainField_t &F, - std::enable_if_t &P) + iterable_proxy(MaterialMuSpectre & mat, const StrainField_t & F, + std::enable_if_t & P) : material{mat}, strain_field{F}, stress_tup{P}, internals{material.get_internals()} {}; //! Expected type for strain fields using StrainMap_t = typename traits::StrainMap_t; //! Expected type for stress fields using StressMap_t = typename traits::StressMap_t; //! Expected type for tangent stiffness fields using TangentMap_t = typename traits::TangentMap_t; //! expected type for strain values using Strain_t = typename traits::StrainMap_t::reference; //! expected type for stress values using Stress_t = typename traits::StressMap_t::reference; //! expected type for tangent stiffness values using Tangent_t = typename traits::TangentMap_t::reference; //! tuple of intervnal variables, depends on the material using InternalVariables = typename traits::InternalVariables; //! tuple containing a stress and possibly a tangent stiffness field using StressFieldTup = std::conditional_t<(NeedTgt == NeedTangent::yes), std::tuple, std::tuple>; //! tuple containing a stress and possibly a tangent stiffness field map using StressMapTup = std::conditional_t<(NeedTgt == NeedTangent::yes), std::tuple, std::tuple>; //! tuple containing a stress and possibly a tangent stiffness value ref using Stress_tTup = std::conditional_t<(NeedTgt == NeedTangent::yes), std::tuple, std::tuple>; //! Copy constructor - iterable_proxy(const iterable_proxy &other) = default; + iterable_proxy(const iterable_proxy & other) = default; //! Move constructor - iterable_proxy(iterable_proxy &&other) = default; + iterable_proxy(iterable_proxy && other) = default; //! Destructor virtual ~iterable_proxy() = default; //! Copy assignment operator - iterable_proxy &operator=(const iterable_proxy &other) = default; + iterable_proxy & operator=(const iterable_proxy & other) = default; //! Move assignment operator - iterable_proxy &operator=(iterable_proxy &&other) = default; + iterable_proxy & operator=(iterable_proxy && other) = default; /** * dereferences into a tuple containing strains, and internal * variables, as well as maps to the stress and potentially * stiffness maps where to write the response of a pixel */ class iterator { public: //! type to refer to internal variables owned by a CRTP material using InternalReferences = MatTB::ReferenceTuple_t; //! return type to be unpacked per pixel my the constitutive law using value_type = std::tuple, Stress_tTup, InternalReferences>; using iterator_category = std::forward_iterator_tag; //!< stl conformance //! Default constructor iterator() = delete; /** Iterator uses the material's internal variables field collection to iterate selectively over the global fields (such as the transformation gradient F and first Piola-Kirchhoff stress P. **/ - explicit iterator(const iterable_proxy &it, bool begin = true) - : it{it}, strain_map{it.strain_field}, stress_map(it.stress_tup), + explicit iterator(const iterable_proxy & it, bool begin = true) + : it{it}, strain_map{it.strain_field}, stress_map(it.stress_tup), index{begin ? 0 : it.material.internal_fields.size()} {} //! Copy constructor - iterator(const iterator &other) = default; + iterator(const iterator & other) = default; //! Move constructor - iterator(iterator &&other) = default; + iterator(iterator && other) = default; //! Destructor virtual ~iterator() = default; //! Copy assignment operator - iterator &operator=(const iterator &other) = default; + iterator & operator=(const iterator & other) = default; //! Move assignment operator - iterator &operator=(iterator &&other) = default; + iterator & operator=(iterator && other) = default; //! pre-increment - inline iterator &operator++(); + inline iterator & operator++(); //! dereference inline value_type operator*(); //! inequality - inline bool operator!=(const iterator &other) const; + inline bool operator!=(const iterator & other) const; protected: - const iterable_proxy ⁢ //!< ref to the proxy - StrainMap_t strain_map; //!< map onto the global strain field + const iterable_proxy & it; //!< ref to the proxy + StrainMap_t strain_map; //!< map onto the global strain field //! map onto the global stress field and possibly tangent stiffness StressMapTup stress_map; size_t index; //!< index or pixel currently referred to private: }; //! returns iterator to first pixel if this material iterator begin() { return std::move(iterator(*this)); } //! returns iterator past the last pixel in this material iterator end() { return std::move(iterator(*this, false)); } protected: - MaterialMuSpectre &material; //!< reference to the proxied material - const StrainField_t &strain_field; //!< cell's global strain field + MaterialMuSpectre & material; //!< reference to the proxied material + const StrainField_t & strain_field; //!< cell's global strain field //! references to the global stress field and perhaps tangent stiffness StressFieldTup stress_tup; //! references to the internal variables - InternalVariables &internals; + InternalVariables & internals; private: }; /* ---------------------------------------------------------------------- */ template template bool MaterialMuSpectre::iterable_proxy::iterator:: - operator!=(const iterator &other) const { + operator!=(const iterator & other) const { return (this->index != other.index); } /* ---------------------------------------------------------------------- */ template template typename MaterialMuSpectre::template iterable_proxy::iterator & MaterialMuSpectre::iterable_proxy::iterator:: operator++() { this->index++; return *this; } /* ---------------------------------------------------------------------- */ template template typename MaterialMuSpectre::template iterable_proxy< NeedTgT>::iterator::value_type MaterialMuSpectre::iterable_proxy::iterator::operator*() { const Ccoord_t pixel{ this->it.material.internal_fields.get_ccoord(this->index)}; - auto &&strain = std::make_tuple(this->strain_map[pixel]); + auto && strain = std::make_tuple(this->strain_map[pixel]); - auto &&stresses = apply( + auto && stresses = apply( [&pixel](auto &&... stress_tgt) { return std::make_tuple(stress_tgt[pixel]...); }, this->stress_map); - auto &&internal = this->it.material.get_internals(); + auto && internal = this->it.material.get_internals(); const auto id{this->index}; - auto &&internals = apply( + auto && internals = apply( [id](auto &&... internals_) { return InternalReferences{internals_[id]...}; }, internal); return std::make_tuple(std::move(strain), std::move(stresses), std::move(internals)); } } // namespace muSpectre #endif // SRC_MATERIALS_MATERIAL_MUSPECTRE_BASE_HH_ diff --git a/src/materials/materials_toolbox.hh b/src/materials/materials_toolbox.hh index 80b9e94..2f1f83c 100644 --- a/src/materials/materials_toolbox.hh +++ b/src/materials/materials_toolbox.hh @@ -1,669 +1,673 @@ /** * @file materials_toolbox.hh * * @author Till Junge * * @date 02 Nov 2017 * * @brief collection of common continuum mechanics tools * * Copyright © 2017 Till Junge * * µSpectre 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, 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 Lesser General Public License * along with µSpectre; see the file COPYING. If not, write to the * Free Software Foundation, Inc., 59 Temple Place - Suite 330, * * Boston, MA 02111-1307, USA. * * Additional permission under GNU GPL version 3 section 7 * * If you modify this Program, or any covered work, by linking or combining it * with proprietary FFT implementations or numerical libraries, containing parts * covered by the terms of those libraries' licenses, the licensors of this * Program grant you additional permission to convey the resulting work. */ #ifndef SRC_MATERIALS_MATERIALS_TOOLBOX_HH_ #define SRC_MATERIALS_MATERIALS_TOOLBOX_HH_ #include "common/common.hh" #include "common/tensor_algebra.hh" #include "common/eigen_tools.hh" #include "common/T4_map_proxy.hh" #include #include #include #include #include #include #include namespace muSpectre { namespace MatTB { /** * thrown when generic materials-related runtime errors occur * (mostly continuum mechanics problems) */ class MaterialsToolboxError : public std::runtime_error { public: //! constructor - explicit MaterialsToolboxError(const std::string &what) + explicit MaterialsToolboxError(const std::string & what) : std::runtime_error(what) {} //! constructor - explicit MaterialsToolboxError(const char *what) + explicit MaterialsToolboxError(const char * what) : std::runtime_error(what) {} }; /* ---------------------------------------------------------------------- */ /** * Flag used to designate whether the material should compute both stress * and tangent moduli or only stress */ enum class NeedTangent { yes, //!< compute both stress and tangent moduli no //!< compute only stress }; /** * struct used to determine the exact type of a tuple of references obtained * when a bunch of iterators over fiel_maps are dereferenced and their * results are concatenated into a tuple */ - template struct ReferenceTuple { + template + struct ReferenceTuple { //! use this type using type = std::tuple; }; /** * specialisation for tuples */ // template <> - template struct ReferenceTuple> { + template + struct ReferenceTuple> { //! use this type using type = typename ReferenceTuple::type; }; /** * helper type for ReferenceTuple */ template using ReferenceTuple_t = typename ReferenceTuple::type; /* ---------------------------------------------------------------------- */ namespace internal { /** Structure for functions returning one strain measure as a * function of another **/ - template struct ConvertStrain { + template + struct ConvertStrain { static_assert((In == StrainMeasure::Gradient) || (In == StrainMeasure::Infinitesimal), "This situation makes me suspect that you are not using " "MatTb as intended. Disable this assert only if you are " "sure about what you are doing."); //! returns the converted strain template - inline static decltype(auto) compute(Strain_t &&input) { + inline static decltype(auto) compute(Strain_t && input) { // transparent case, in which no conversion is required: // just a perfect forwarding static_assert((In == Out), "This particular strain conversion is not implemented"); return std::forward(input); } }; /* ---------------------------------------------------------------------- */ /** Specialisation for getting Green-Lagrange strain from the transformation gradient E = ¹/₂ (C - I) = ¹/₂ (Fᵀ·F - I) **/ template <> struct ConvertStrain { //! returns the converted strain template - inline static decltype(auto) compute(Strain_t &&F) { + inline static decltype(auto) compute(Strain_t && F) { return .5 * (F.transpose() * F - Strain_t::PlainObject::Identity()); } }; /* ---------------------------------------------------------------------- */ /** Specialisation for getting Left Cauchy-Green strain from the transformation gradient B = F·Fᵀ = V² **/ template <> struct ConvertStrain { //! returns the converted strain template - inline static decltype(auto) compute(Strain_t &&F) { + inline static decltype(auto) compute(Strain_t && F) { return F * F.transpose(); } }; /* ---------------------------------------------------------------------- */ /** Specialisation for getting Right Cauchy-Green strain from the transformation gradient C = Fᵀ·F = U² **/ template <> struct ConvertStrain { //! returns the converted strain template - inline static decltype(auto) compute(Strain_t &&F) { + inline static decltype(auto) compute(Strain_t && F) { return F.transpose() * F; } }; /* ---------------------------------------------------------------------- */ /** Specialisation for getting logarithmic (Hencky) strain from the transformation gradient E₀ = ¹/₂ ln C = ¹/₂ ln (Fᵀ·F) **/ template <> struct ConvertStrain { //! returns the converted strain template - inline static decltype(auto) compute(Strain_t &&F) { + inline static decltype(auto) compute(Strain_t && F) { constexpr Dim_t dim{EigenCheck::tensor_dim::value}; return (.5 * logm(Eigen::Matrix{F.transpose() * F})) .eval(); } }; } // namespace internal /* ---------------------------------------------------------------------- */ //! set of functions returning one strain measure as a function of //! another template - decltype(auto) convert_strain(Strain_t &&strain) { + decltype(auto) convert_strain(Strain_t && strain) { return internal::ConvertStrain::compute(std::move(strain)); } /* ---------------------------------------------------------------------- */ namespace internal { /** Structure for functions returning PK1 stress from other stress - *measures + *measures **/ template struct PK1_stress { //! returns the converted stress template inline static decltype(auto) compute(Strain_t && /*strain*/, Stress_t && /*stress*/) { // the following test always fails to generate a compile-time error static_assert((StressM == StressMeasure::Cauchy) && (StressM == StressMeasure::PK1), "The requested Stress conversion is not implemented. " "You either made a programming mistake or need to " "implement it as a specialisation of this function. " "See PK2stress for an example."); } //! returns the converted stress and stiffness template inline static decltype(auto) compute(Strain_t && /*strain*/, Stress_t && /*stress*/, Tangent_t && /*stiffness*/) { // the following test always fails to generate a compile-time error static_assert((StressM == StressMeasure::Cauchy) && (StressM == StressMeasure::PK1), "The requested Stress conversion is not implemented. " "You either made a programming mistake or need to " "implement it as a specialisation of this function. " "See PK2stress for an example."); } }; /* ---------------------------------------------------------------------- */ /** Specialisation for the transparent case, where we already have PK1 stress **/ template struct PK1_stress : public PK1_stress { //! returns the converted stress template inline static decltype(auto) compute(Strain_t && /*dummy*/, - Stress_t &&P) { + Stress_t && P) { return std::forward(P); } }; /* ---------------------------------------------------------------------- */ /** Specialisation for the transparent case, where we already have PK1 stress *and* stiffness is given with respect to the transformation gradient **/ template struct PK1_stress : public PK1_stress { //! base class using Parent = PK1_stress; using Parent::compute; //! returns the converted stress and stiffness template inline static decltype(auto) compute(Strain_t && /*dummy*/, - Stress_t &&P, Tangent_t &&K) { + Stress_t && P, Tangent_t && K) { return std::make_tuple(std::forward(P), std::forward(K)); } }; /* ---------------------------------------------------------------------- */ /** * Specialisation for the case where we get material stress (PK2) */ template struct PK1_stress : public PK1_stress { //! returns the converted stress template - inline static decltype(auto) compute(Strain_t &&F, Stress_t &&S) { + inline static decltype(auto) compute(Strain_t && F, Stress_t && S) { return F * S; } }; /* ---------------------------------------------------------------------- */ /** * Specialisation for the case where we get material stress (PK2) derived * with respect to Green-Lagrange strain */ template struct PK1_stress : public PK1_stress { //! base class using Parent = PK1_stress; using Parent::compute; //! returns the converted stress and stiffness template - inline static decltype(auto) compute(Strain_t &&F, Stress_t &&S, - Tangent_t &&C) { + inline static decltype(auto) compute(Strain_t && F, Stress_t && S, + Tangent_t && C) { using T4 = typename std::remove_reference_t::PlainObject; using Tmap = T4MatMap; T4 K; Tmap Kmap{K.data()}; K.setZero(); for (int i = 0; i < Dim; ++i) { for (int m = 0; m < Dim; ++m) { for (int n = 0; n < Dim; ++n) { get(Kmap, i, m, i, n) += S(m, n); for (int j = 0; j < Dim; ++j) { for (int r = 0; r < Dim; ++r) { for (int s = 0; s < Dim; ++s) { get(Kmap, i, m, j, n) += F(i, r) * get(C, r, m, n, s) * (F(j, s)); } } } } } } - auto &&P = + auto && P = compute(std::forward(F), std::forward(S)); return std::make_tuple(std::move(P), std::move(K)); } }; /* ---------------------------------------------------------------------- */ /** * Specialisation for the case where we get Kirchhoff stress (τ) */ template struct PK1_stress : public PK1_stress { //! returns the converted stress template - inline static decltype(auto) compute(Strain_t &&F, Stress_t &&tau) { + inline static decltype(auto) compute(Strain_t && F, Stress_t && tau) { return tau * F.inverse().transpose(); } }; /* ---------------------------------------------------------------------- */ /** * Specialisation for the case where we get Kirchhoff stress (τ) derived * with respect to Gradient */ template struct PK1_stress : public PK1_stress { //! short-hand using Parent = PK1_stress; using Parent::compute; //! returns the converted stress and stiffness template - inline static decltype(auto) compute(Strain_t &&F, Stress_t &&tau, - Tangent_t &&C) { + inline static decltype(auto) compute(Strain_t && F, Stress_t && tau, + Tangent_t && C) { using T4 = typename std::remove_reference_t::PlainObject; using Tmap = T4MatMap; T4 K; Tmap Kmap{K.data()}; K.setZero(); - auto &&F_inv{F.inverse()}; + auto && F_inv{F.inverse()}; for (int i = 0; i < Dim; ++i) { for (int m = 0; m < Dim; ++m) { for (int n = 0; n < Dim; ++n) { for (int j = 0; j < Dim; ++j) { for (int r = 0; r < Dim; ++r) { for (int s = 0; s < Dim; ++s) { get(Kmap, i, m, j, n) += F_inv(i, r) * get(C, r, m, n, s); } } } } } } - auto &&P = tau * F_inv.transpose(); + auto && P = tau * F_inv.transpose(); return std::make_tuple(std::move(P), std::move(K)); } }; } // namespace internal /* ---------------------------------------------------------------------- */ //! set of functions returning an expression for PK2 stress based on template - decltype(auto) PK1_stress(Strain_t &&strain, Stress_t &&stress) { + decltype(auto) PK1_stress(Strain_t && strain, Stress_t && stress) { constexpr Dim_t dim{EigenCheck::tensor_dim::value}; static_assert((dim == EigenCheck::tensor_dim::value), "Stress and strain tensors have differing dimensions"); return internal::PK1_stress::compute( std::forward(strain), std::forward(stress)); } /* ---------------------------------------------------------------------- */ //! set of functions returning an expression for PK2 stress based on template - decltype(auto) PK1_stress(Strain_t &&strain, Stress_t &&stress, - Tangent_t &&tangent) { + decltype(auto) PK1_stress(Strain_t && strain, Stress_t && stress, + Tangent_t && tangent) { constexpr Dim_t dim{EigenCheck::tensor_dim::value}; static_assert((dim == EigenCheck::tensor_dim::value), "Stress and strain tensors have differing dimensions"); static_assert((dim == EigenCheck::tensor_4_dim::value), "Stress and tangent tensors have differing dimensions"); return internal::PK1_stress::compute( std::forward(strain), std::forward(stress), std::forward(tangent)); } namespace internal { //! Base template for elastic modulus conversion template struct Converter { //! wrapped function (raison d'être) inline constexpr static Real compute(const Real & /*in1*/, const Real & /*in2*/) { // if no return has happened until now, the conversion is not // implemented yet static_assert( (In1 == In2), "This conversion has not been implemented yet, please add " "it here below as a specialisation of this function " "template. Check " "https://en.wikipedia.org/wiki/Lam%C3%A9_parameters for " "// TODO: he formula."); return 0; } }; /** * Spectialisation for when the output is the first input */ template struct Converter { //! wrapped function (raison d'être) - inline constexpr static Real compute(const Real &A, + inline constexpr static Real compute(const Real & A, const Real & /*B*/) { return A; } }; /** * Spectialisation for when the output is the second input */ template struct Converter { //! wrapped function (raison d'être) inline constexpr static Real compute(const Real & /*A*/, - const Real &B) { + const Real & B) { return B; } }; /** * Specialisation μ(E, ν) */ template <> struct Converter { //! wrapped function (raison d'être) - inline constexpr static Real compute(const Real &E, const Real &nu) { + inline constexpr static Real compute(const Real & E, const Real & nu) { return E / (2 * (1 + nu)); } }; /** * Specialisation λ(E, ν) */ template <> struct Converter { //! wrapped function (raison d'être) - inline constexpr static Real compute(const Real &E, const Real &nu) { + inline constexpr static Real compute(const Real & E, const Real & nu) { return E * nu / ((1 + nu) * (1 - 2 * nu)); } }; /** * Specialisation K(E, ν) */ template <> struct Converter { //! wrapped function (raison d'être) - inline constexpr static Real compute(const Real &E, const Real &nu) { + inline constexpr static Real compute(const Real & E, const Real & nu) { return E / (3 * (1 - 2 * nu)); } }; /** * Specialisation E(K, µ) */ template <> struct Converter { //! wrapped function (raison d'être) - inline constexpr static Real compute(const Real &K, const Real &G) { + inline constexpr static Real compute(const Real & K, const Real & G) { return 9 * K * G / (3 * K + G); } }; /** * Specialisation ν(K, µ) */ template <> struct Converter { //! wrapped function (raison d'être) - inline constexpr static Real compute(const Real &K, const Real &G) { + inline constexpr static Real compute(const Real & K, const Real & G) { return (3 * K - 2 * G) / (2 * (3 * K + G)); } }; /** * Specialisation E(λ, µ) */ template <> struct Converter { //! wrapped function (raison d'être) - inline constexpr static Real compute(const Real &lambda, - const Real &G) { + inline constexpr static Real compute(const Real & lambda, + const Real & G) { return G * (3 * lambda + 2 * G) / (lambda + G); } }; } // namespace internal /** * allows the conversion from any two distinct input moduli to a * chosen output modulus */ template - inline constexpr Real convert_elastic_modulus(const Real &in1, - const Real &in2) { + inline constexpr Real convert_elastic_modulus(const Real & in1, + const Real & in2) { // enforcing sanity static_assert((In1 != In2), "The input modulus types cannot be identical"); // enforcing independence from order in which moduli are supplied constexpr bool inverted{In1 > In2}; using Converter = std::conditional_t, internal::Converter>; if (inverted) { return Converter::compute(std::move(in2), std::move(in1)); } else { return Converter::compute(std::move(in1), std::move(in2)); } } //! static inline implementation of Hooke's law - template struct Hooke { + template + struct Hooke { /** * compute Lamé's first constant * @param young: Young's modulus * @param poisson: Poisson's ratio */ - inline static constexpr Real compute_lambda(const Real &young, - const Real &poisson) { + inline static constexpr Real compute_lambda(const Real & young, + const Real & poisson) { return convert_elastic_modulus(young, poisson); } /** * compute Lamé's second constant (i.e., shear modulus) * @param young: Young's modulus * @param poisson: Poisson's ratio */ - inline static constexpr Real compute_mu(const Real &young, - const Real &poisson) { + inline static constexpr Real compute_mu(const Real & young, + const Real & poisson) { return convert_elastic_modulus(young, poisson); } /** * compute the bulk modulus * @param young: Young's modulus * @param poisson: Poisson's ratio */ - inline static constexpr Real compute_K(const Real &young, - const Real &poisson) { + inline static constexpr Real compute_K(const Real & young, + const Real & poisson) { return convert_elastic_modulus(young, poisson); } /** * compute the stiffness tensor * @param lambda: Lamé's first constant * @param mu: Lamé's second constant (i.e., shear modulus) */ inline static Eigen::TensorFixedSize> - compute_C(const Real &lambda, const Real &mu) { + compute_C(const Real & lambda, const Real & mu) { return lambda * Tensors::outer(Tensors::I2(), Tensors::I2()) + 2 * mu * Tensors::I4S(); } /** * compute the stiffness tensor * @param lambda: Lamé's first constant * @param mu: Lamé's second constant (i.e., shear modulus) */ - inline static T4Mat compute_C_T4(const Real &lambda, - const Real &mu) { + inline static T4Mat compute_C_T4(const Real & lambda, + const Real & mu) { return lambda * Matrices::Itrac() + 2 * mu * Matrices::Isymm(); } /** * return stress * @param lambda: First Lamé's constant * @param mu: Second Lamé's constant (i.e. shear modulus) * @param E: Green-Lagrange or small strain tensor */ template - inline static decltype(auto) evaluate_stress(const Real &lambda, - const Real &mu, s_t &&E) { + inline static decltype(auto) evaluate_stress(const Real & lambda, + const Real & mu, s_t && E) { return E.trace() * lambda * Strain_t::Identity() + 2 * mu * E; } /** * return stress and tangent stiffness * @param lambda: First Lamé's constant * @param mu: Second Lamé's constant (i.e. shear modulus) * @param E: Green-Lagrange or small strain tensor * @param C: stiffness tensor (Piola-Kirchhoff 2 (or σ) w.r.t to `E`) */ template - inline static decltype(auto) evaluate_stress(const Real &lambda, - const Real &mu, - Tangent_t &&C, s_t &&E) { + inline static decltype(auto) evaluate_stress(const Real & lambda, + const Real & mu, + Tangent_t && C, s_t && E) { return std::make_tuple( std::move(evaluate_stress(lambda, mu, std::move(E))), std::move(C)); } }; } // namespace MatTB } // namespace muSpectre #endif // SRC_MATERIALS_MATERIALS_TOOLBOX_HH_ diff --git a/src/solver/deprecated_solver_base.cc b/src/solver/deprecated_solver_base.cc index 4f4d774..f3b6196 100644 --- a/src/solver/deprecated_solver_base.cc +++ b/src/solver/deprecated_solver_base.cc @@ -1,68 +1,68 @@ /** * @file deprecated_solver_base.cc * * @author Till Junge * * @date 18 Dec 2017 * * @brief definitions for solvers * * Copyright © 2017 Till Junge * * µSpectre 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, 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 Lesser General Public License * along with µSpectre; see the file COPYING. If not, write to the * Free Software Foundation, Inc., 59 Temple Place - Suite 330, * * Boston, MA 02111-1307, USA. * * Additional permission under GNU GPL version 3 section 7 * * If you modify this Program, or any covered work, by linking or combining it * with proprietary FFT implementations or numerical libraries, containing parts * covered by the terms of those libraries' licenses, the licensors of this * Program grant you additional permission to convey the resulting work. */ #include "solver/deprecated_solver_base.hh" #include "solver/deprecated_solver_cg.hh" #include "common/field.hh" #include "common/iterators.hh" #include #include namespace muSpectre { //--------------------------------------------------------------------------// template - DeprecatedSolverBase::DeprecatedSolverBase(Cell_t &cell, Real tol, - Uint maxiter, + DeprecatedSolverBase::DeprecatedSolverBase(Cell_t & cell, + Real tol, Uint maxiter, bool verbose) : cell{cell}, tol{tol}, maxiter{maxiter}, verbose{verbose} {} /* ---------------------------------------------------------------------- */ template void DeprecatedSolverBase::reset_counter() { this->counter = 0; } /* ---------------------------------------------------------------------- */ template Uint DeprecatedSolverBase::get_counter() const { return this->counter; } template class DeprecatedSolverBase; // template class DeprecatedSolverBase; template class DeprecatedSolverBase; } // namespace muSpectre diff --git a/src/solver/deprecated_solver_base.hh b/src/solver/deprecated_solver_base.hh index 80df72d..579680f 100644 --- a/src/solver/deprecated_solver_base.hh +++ b/src/solver/deprecated_solver_base.hh @@ -1,158 +1,160 @@ /** * @file deprecated_solver_base.hh * * @author Till Junge * * @date 18 Dec 2017 * * @brief Base class for solvers * * Copyright © 2017 Till Junge * * µSpectre 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, 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 Lesser General Public License * along with µSpectre; see the file COPYING. If not, write to the * Free Software Foundation, Inc., 59 Temple Place - Suite 330, * * Boston, MA 02111-1307, USA. * * Additional permission under GNU GPL version 3 section 7 * * If you modify this Program, or any covered work, by linking or combining it * with proprietary FFT implementations or numerical libraries, containing parts * covered by the terms of those libraries' licenses, the licensors of this * Program grant you additional permission to convey the resulting work. */ #ifndef SRC_SOLVER_DEPRECATED_SOLVER_BASE_HH_ #define SRC_SOLVER_DEPRECATED_SOLVER_BASE_HH_ #include "solver/solver_common.hh" #include "common/common.hh" #include "cell/cell_base.hh" #include "common/tensor_algebra.hh" #include #include namespace muSpectre { /* ---------------------------------------------------------------------- */ /** * Virtual base class for solvers. Any implementation of this interface can be * used with the solver functions prototyped in solvers.hh */ - template class DeprecatedSolverBase { + template + class DeprecatedSolverBase { public: /** * Enum to describe in what kind the solver relies tangent stiffnesses */ enum class TangentRequirement { NoNeed, NeedEffect, NeedTangents }; using Cell_t = CellBase; //!< Cell type using Ccoord = Ccoord_t; //!< cell coordinates type //! Field collection to store temporary fields in using Collection_t = GlobalFieldCollection; //! Input vector for solvers using SolvVectorIn = Eigen::Ref; //! Input vector for solvers using SolvVectorInC = Eigen::Ref; //! Output vector for solvers using SolvVectorOut = Eigen::VectorXd; //! Default constructor DeprecatedSolverBase() = delete; //! Constructor with domain resolutions - DeprecatedSolverBase(Cell_t &cell, Real tol, Uint maxiter = 0, + DeprecatedSolverBase(Cell_t & cell, Real tol, Uint maxiter = 0, bool verbose = false); //! Copy constructor - DeprecatedSolverBase(const DeprecatedSolverBase &other) = delete; + DeprecatedSolverBase(const DeprecatedSolverBase & other) = delete; //! Move constructor - DeprecatedSolverBase(DeprecatedSolverBase &&other) = default; + DeprecatedSolverBase(DeprecatedSolverBase && other) = default; //! Destructor virtual ~DeprecatedSolverBase() = default; //! Copy assignment operator - DeprecatedSolverBase &operator=(const DeprecatedSolverBase &other) = delete; + DeprecatedSolverBase & + operator=(const DeprecatedSolverBase & other) = delete; //! Move assignment operator - DeprecatedSolverBase &operator=(DeprecatedSolverBase &&other) = default; + DeprecatedSolverBase & operator=(DeprecatedSolverBase && other) = default; //! Allocate fields used during the solution virtual void initialise() { this->collection.initialise(this->cell.get_subdomain_resolutions(), this->cell.get_subdomain_locations()); } //! determine whether this solver requires full tangent stiffnesses bool need_tangents() const { return (this->get_tangent_req() == TangentRequirement::NeedTangents); } //! determine whether this solver requires evaluation of directional tangent bool need_effect() const { return (this->get_tangent_req() == TangentRequirement::NeedEffect); } //! determine whether this solver has no need for tangents bool no_need_tangent() const { return (this->get_tangent_req() == TangentRequirement::NoNeed); } //! returns whether the solver has converged virtual bool has_converged() const = 0; //! reset the iteration counter to zero void reset_counter(); //! get the count of how many solve steps have been executed since //! construction of most recent counter reset Uint get_counter() const; //! executes the solver virtual SolvVectorOut solve(const SolvVectorInC rhs, SolvVectorIn x_0) = 0; //! return a reference to the cell - Cell_t &get_cell() { return cell; } + Cell_t & get_cell() { return cell; } //! read the current maximum number of iterations setting Uint get_maxiter() const { return this->maxiter; } //! set the maximum number of iterations void set_maxiter(Uint val) { this->maxiter = val; } //! read the current tolerance setting Real get_tol() const { return this->tol; } //! set the torelance setting void set_tol(Real val) { this->tol = val; } //! returns the name of the solver virtual std::string name() const = 0; protected: //! returns the tangent requirements of this solver virtual TangentRequirement get_tangent_req() const = 0; - Cell_t &cell; //!< reference to the cell + Cell_t & cell; //!< reference to the cell Real tol; //!< convergence tolerance Uint maxiter; //!< maximum number of iterations bool verbose; //!< whether or not to write information to the std output Uint counter{0}; //!< iteration counter //! storage for internal fields to avoid reallocations between calls Collection_t collection{}; private: }; } // namespace muSpectre #endif // SRC_SOLVER_DEPRECATED_SOLVER_BASE_HH_ diff --git a/src/solver/deprecated_solver_cg.cc b/src/solver/deprecated_solver_cg.cc index 4406d87..1b3ae91 100644 --- a/src/solver/deprecated_solver_cg.cc +++ b/src/solver/deprecated_solver_cg.cc @@ -1,137 +1,138 @@ /** * @file deprecated_solver_cg.cc * * @author Till Junge * * @date 20 Dec 2017 * * @brief Implementation of cg solver * * Copyright © 2017 Till Junge * * µSpectre 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, 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 Lesser General Public License * along with µSpectre; see the file COPYING. If not, write to the * Free Software Foundation, Inc., 59 Temple Place - Suite 330, * * Boston, MA 02111-1307, USA. * * Additional permission under GNU GPL version 3 section 7 * * If you modify this Program, or any covered work, by linking or combining it * with proprietary FFT implementations or numerical libraries, containing parts * covered by the terms of those libraries' licenses, the licensors of this * Program grant you additional permission to convey the resulting work. */ #include "solver/deprecated_solver_cg.hh" #include "solver/solver_common.hh" #include #include #include namespace muSpectre { /* ---------------------------------------------------------------------- */ template - DeprecatedSolverCG::DeprecatedSolverCG(Cell_t &cell, Real tol, + DeprecatedSolverCG::DeprecatedSolverCG(Cell_t & cell, Real tol, Uint maxiter, bool verbose) : Parent(cell, tol, maxiter, verbose), r_k{make_field( "residual r_k", this->collection)}, p_k{make_field("search direction r_k", this->collection)}, Ap_k{make_field("Effect of tangent A*p_k", this->collection)} { } /* ---------------------------------------------------------------------- */ template - void DeprecatedSolverCG::solve(const Field_t &rhs, Field_t &x_f) { + void DeprecatedSolverCG::solve(const Field_t & rhs, + Field_t & x_f) { x_f.eigenvec() = this->solve(rhs.eigenvec(), x_f.eigenvec()); } //----------------------------------------------------------------------------// template typename DeprecatedSolverCG::SolvVectorOut DeprecatedSolverCG::solve(const SolvVectorInC rhs, SolvVectorIn x_0) { - const Communicator &comm = this->cell.get_communicator(); + const Communicator & comm = this->cell.get_communicator(); // 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(); typename Field_t::EigenMap_t x(x_0.data(), r.rows(), r.cols()); // initialisation of algo r = this->cell.directional_stiffness_with_copy(x); r -= typename Field_t::ConstEigenMap_t(rhs.data(), r.rows(), r.cols()); p = -r; this->converged = false; Real rdr = comm.sum((r * r).sum()); Real rhs_norm2 = comm.sum(rhs.squaredNorm()); Real tol2 = ipow(this->tol, 2) * rhs_norm2; 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 == 0); ++i, ++this->counter) { Ap = this->cell.directional_stiffness_with_copy(p); Real alpha = rdr / comm.sum((p * Ap).sum()); x += alpha * p; r += alpha * Ap; Real new_rdr = comm.sum((r * r).sum()); Real beta = new_rdr / rdr; rdr = new_rdr; if (this->verbose && comm.rank() == 0) { std::cout << " at CG step " << std::setw(count_width) << i << ": |r|/|b| = " << std::setw(15) << std::sqrt(rdr / rhs_norm2) << ", cg_tol = " << this->tol << std::endl; } p = -r + beta * p; } if (rdr < tol2) { this->converged = true; } else { std::stringstream err{}; err << " After " << this->counter << " steps, the solver " << " FAILED with |r|/|b| = " << std::setw(15) << std::sqrt(rdr / rhs_norm2) << ", cg_tol = " << this->tol << std::endl; throw ConvergenceError("Conjugate gradient has not converged." + err.str()); } return x_0; } /* ---------------------------------------------------------------------- */ template typename DeprecatedSolverCG::Tg_req_t DeprecatedSolverCG::get_tangent_req() const { return tangent_requirement; } template class DeprecatedSolverCG; // template class DeprecatedSolverCG; template class DeprecatedSolverCG; } // namespace muSpectre diff --git a/src/solver/deprecated_solver_cg.hh b/src/solver/deprecated_solver_cg.hh index 68565e2..0af0414 100644 --- a/src/solver/deprecated_solver_cg.hh +++ b/src/solver/deprecated_solver_cg.hh @@ -1,123 +1,122 @@ /** * @file deprecated_solver_cg.hh * * @author Till Junge * * @date 20 Dec 2017 * * @brief class for a simple implementation of a conjugate gradient * solver. This follows algorithm 5.2 in Nocedal's Numerical * Optimization (p 112) * * Copyright © 2017 Till Junge * * µSpectre 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, 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 Lesser General Public License * along with µSpectre; see the file COPYING. If not, write to the * Free Software Foundation, Inc., 59 Temple Place - Suite 330, * * Boston, MA 02111-1307, USA. * * Additional permission under GNU GPL version 3 section 7 * * If you modify this Program, or any covered work, by linking or combining it * with proprietary FFT implementations or numerical libraries, containing parts * covered by the terms of those libraries' licenses, the licensors of this * Program grant you additional permission to convey the resulting work. */ #ifndef SRC_SOLVER_DEPRECATED_SOLVER_CG_HH_ #define SRC_SOLVER_DEPRECATED_SOLVER_CG_HH_ #include "solver/deprecated_solver_base.hh" #include "common/communicator.hh" #include "common/field.hh" #include namespace muSpectre { /** * implements the `muSpectre::DeprecatedSolverBase` interface using a * conjugate gradient solver. This particular class is useful for * trouble shooting, as it can be made very verbose, but for * production runs, it is probably better to use * `muSpectre::DeprecatedSolverCGEigen`. */ template class DeprecatedSolverCG : public DeprecatedSolverBase { public: using Parent = DeprecatedSolverBase; //!< base class //! Input vector for solvers using SolvVectorIn = typename Parent::SolvVectorIn; //! Input vector for solvers using SolvVectorInC = typename Parent::SolvVectorInC; //! Output vector for solvers using SolvVectorOut = typename Parent::SolvVectorOut; using Cell_t = typename Parent::Cell_t; //!< cell type using Ccoord = typename Parent::Ccoord; //!< cell coordinates type //! kind of tangent that is required using Tg_req_t = typename Parent::TangentRequirement; //! cg only needs to handle fields that look like strain and stress using Field_t = TensorField; //! conjugate gradient needs directional stiffness constexpr static Tg_req_t tangent_requirement{Tg_req_t::NeedEffect}; //! Default constructor DeprecatedSolverCG() = delete; //! Constructor with domain resolutions, etc, - DeprecatedSolverCG(Cell_t &cell, Real tol, Uint maxiter = 0, + DeprecatedSolverCG(Cell_t & cell, Real tol, Uint maxiter = 0, bool verbose = false); //! Copy constructor - DeprecatedSolverCG(const DeprecatedSolverCG &other) = delete; + DeprecatedSolverCG(const DeprecatedSolverCG & other) = delete; //! Move constructor - DeprecatedSolverCG(DeprecatedSolverCG &&other) = default; + DeprecatedSolverCG(DeprecatedSolverCG && other) = default; //! Destructor virtual ~DeprecatedSolverCG() = default; //! Copy assignment operator - DeprecatedSolverCG &operator=(const DeprecatedSolverCG &other) = delete; + DeprecatedSolverCG & operator=(const DeprecatedSolverCG & other) = delete; //! Move assignment operator - DeprecatedSolverCG &operator=(DeprecatedSolverCG &&other) = default; + DeprecatedSolverCG & operator=(DeprecatedSolverCG && other) = default; bool has_converged() const final { return this->converged; } //! actual solver - void solve(const Field_t &rhs, Field_t &x); + void solve(const Field_t & rhs, Field_t & x); // this simplistic implementation has no initialisation phase so the default // is ok - SolvVectorOut solve(const SolvVectorInC rhs, - SolvVectorIn x_0) final; + SolvVectorOut solve(const SolvVectorInC rhs, SolvVectorIn x_0) final; std::string name() const final { return "CG"; } protected: //! returns `muSpectre::Tg_req_t::NeedEffect` Tg_req_t get_tangent_req() const final; - Field_t &r_k; //!< residual - Field_t &p_k; //!< search direction - Field_t &Ap_k; //!< effect of tangent on search direction + Field_t & r_k; //!< residual + Field_t & p_k; //!< search direction + Field_t & Ap_k; //!< effect of tangent on search direction bool converged{false}; //!< whether the solver has converged private: }; } // namespace muSpectre #endif // SRC_SOLVER_DEPRECATED_SOLVER_CG_HH_ diff --git a/src/solver/deprecated_solver_cg_eigen.cc b/src/solver/deprecated_solver_cg_eigen.cc index daf54b6..eb66f36 100644 --- a/src/solver/deprecated_solver_cg_eigen.cc +++ b/src/solver/deprecated_solver_cg_eigen.cc @@ -1,127 +1,127 @@ /** * @file deprecated_solver_cg_eigen.cc * * @author Till Junge * * @date 19 Jan 2018 * * @brief implementation for binding to Eigen's conjugate gradient solver * * Copyright (C) 2018 Till Junge * * µSpectre 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, 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 Lesser General Public License * along with µSpectre; see the file COPYING. If not, write to the * Free Software Foundation, Inc., 59 Temple Place - Suite 330, * * Boston, MA 02111-1307, USA. * * Additional permission under GNU GPL version 3 section 7 * * If you modify this Program, or any covered work, by linking or combining it * with proprietary FFT implementations or numerical libraries, containing parts * covered by the terms of those libraries' licenses, the licensors of this * Program grant you additional permission to convey the resulting work. */ #include "deprecated_solver_cg_eigen.hh" #include #include namespace muSpectre { //----------------------------------------------------------------------------// template DeprecatedSolverEigen::DeprecatedSolverEigen(Cell_t &cell, Real tol, + DimM>::DeprecatedSolverEigen(Cell_t & cell, Real tol, Uint maxiter, bool verbose) : Parent(cell, tol, maxiter, verbose), adaptor{cell.get_adaptor()}, solver{} {} //----------------------------------------------------------------------------// template void DeprecatedSolverEigen::initialise() { this->solver.setTolerance(this->tol); this->solver.setMaxIterations(this->maxiter); this->solver.compute(this->adaptor); } //----------------------------------------------------------------------------// template typename DeprecatedSolverEigen::SolvVectorOut DeprecatedSolverEigen::solve( const SolvVectorInC rhs, SolvVectorIn x_0) { - auto &this_solver = static_cast(*this); + auto & this_solver = static_cast(*this); SolvVectorOut retval = this->solver.solveWithGuess(rhs, x_0); this->counter += this->solver.iterations(); if (this->solver.info() != Eigen::Success) { std::stringstream err{}; err << this_solver.name() << " has not converged," << " After " << this->solver.iterations() << " steps, the solver " << " FAILED with |r|/|b| = " << std::setw(15) << this->solver.error() << ", cg_tol = " << this->tol << std::endl; throw ConvergenceError(err.str()); } if (this->verbose) { std::cout << " After " << this->solver.iterations() << " " << this_solver.name() << " steps, |r|/|b| = " << std::setw(15) << this->solver.error() << ", cg_tol = " << this->tol << std::endl; } return retval; } /* ---------------------------------------------------------------------- */ template typename DeprecatedSolverEigen::Tg_req_t DeprecatedSolverEigen::get_tangent_req() const { return tangent_requirement; } template class DeprecatedSolverEigen, twoD, twoD>; template class DeprecatedSolverEigen, threeD, threeD>; template class DeprecatedSolverCGEigen; template class DeprecatedSolverCGEigen; template class DeprecatedSolverEigen, twoD, twoD>; template class DeprecatedSolverEigen< DeprecatedSolverGMRESEigen, threeD, threeD>; template class DeprecatedSolverGMRESEigen; template class DeprecatedSolverGMRESEigen; template class DeprecatedSolverEigen< DeprecatedSolverBiCGSTABEigen, twoD, twoD>; template class DeprecatedSolverEigen< DeprecatedSolverBiCGSTABEigen, threeD, threeD>; template class DeprecatedSolverBiCGSTABEigen; template class DeprecatedSolverBiCGSTABEigen; template class DeprecatedSolverEigen, twoD, twoD>; template class DeprecatedSolverEigen< DeprecatedSolverDGMRESEigen, threeD, threeD>; template class DeprecatedSolverDGMRESEigen; template class DeprecatedSolverDGMRESEigen; template class DeprecatedSolverEigen, twoD, twoD>; template class DeprecatedSolverEigen< DeprecatedSolverMINRESEigen, threeD, threeD>; template class DeprecatedSolverMINRESEigen; template class DeprecatedSolverMINRESEigen; } // namespace muSpectre diff --git a/src/solver/deprecated_solver_cg_eigen.hh b/src/solver/deprecated_solver_cg_eigen.hh index 1ad2764..9102c59 100644 --- a/src/solver/deprecated_solver_cg_eigen.hh +++ b/src/solver/deprecated_solver_cg_eigen.hh @@ -1,253 +1,258 @@ /** * @file deprecated_solver_cg_eigen.hh * * @author Till Junge * * @date 19 Jan 2018 * * @brief binding to Eigen's conjugate gradient solver * * Copyright © 2018 Till Junge * * µSpectre 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, 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 Lesser General Public License * along with µSpectre; see the file COPYING. If not, write to the * Free Software Foundation, Inc., 59 Temple Place - Suite 330, * * Boston, MA 02111-1307, USA. * * Additional permission under GNU GPL version 3 section 7 * * If you modify this Program, or any covered work, by linking or combining it * with proprietary FFT implementations or numerical libraries, containing parts * covered by the terms of those libraries' licenses, the licensors of this * Program grant you additional permission to convey the resulting work. */ #ifndef SRC_SOLVER_DEPRECATED_SOLVER_CG_EIGEN_HH_ #define SRC_SOLVER_DEPRECATED_SOLVER_CG_EIGEN_HH_ #include "solver/deprecated_solver_base.hh" #include #include #include namespace muSpectre { template class DeprecatedSolverEigen; - template class DeprecatedSolverCGEigen; + template + class DeprecatedSolverCGEigen; - template class DeprecatedSolverGMRESEigen; + template + class DeprecatedSolverGMRESEigen; - template class DeprecatedSolverBiCGSTABEigen; + template + class DeprecatedSolverBiCGSTABEigen; - template class DeprecatedSolverDGMRESEigen; + template + class DeprecatedSolverDGMRESEigen; - template class DeprecatedSolverMINRESEigen; + template + class DeprecatedSolverMINRESEigen; namespace internal { - template struct DeprecatedSolver_traits {}; + template + struct DeprecatedSolver_traits {}; //! traits for the Eigen conjugate gradient solver template struct DeprecatedSolver_traits> { //! Eigen Iterative DeprecatedSolver using DeprecatedSolver = Eigen::ConjugateGradient< typename DeprecatedSolverEigen, DimS, DimM>::Adaptor, Eigen::Lower | Eigen::Upper, Eigen::IdentityPreconditioner>; }; //! traits for the Eigen GMRES solver template struct DeprecatedSolver_traits> { //! Eigen Iterative DeprecatedSolver using DeprecatedSolver = Eigen::GMRES< typename DeprecatedSolverEigen, DimS, DimM>::Adaptor, Eigen::IdentityPreconditioner>; }; //! traits for the Eigen BiCGSTAB solver template struct DeprecatedSolver_traits> { //! Eigen Iterative DeprecatedSolver using DeprecatedSolver = Eigen::BiCGSTAB< typename DeprecatedSolverEigen< DeprecatedSolverBiCGSTABEigen, DimS, DimM>::Adaptor, Eigen::IdentityPreconditioner>; }; //! traits for the Eigen DGMRES solver template struct DeprecatedSolver_traits> { //! Eigen Iterative DeprecatedSolver using DeprecatedSolver = Eigen::DGMRES< typename DeprecatedSolverEigen< DeprecatedSolverDGMRESEigen, DimS, DimM>::Adaptor, Eigen::IdentityPreconditioner>; }; //! traits for the Eigen MINRES solver template struct DeprecatedSolver_traits> { //! Eigen Iterative DeprecatedSolver using DeprecatedSolver = Eigen::MINRES< typename DeprecatedSolverEigen< DeprecatedSolverMINRESEigen, DimS, DimM>::Adaptor, Eigen::Lower | Eigen::Upper, Eigen::IdentityPreconditioner>; }; } // namespace internal /** * base class for iterative solvers from Eigen */ template class DeprecatedSolverEigen : public DeprecatedSolverBase { public: using Parent = DeprecatedSolverBase; //!< base class //! Input vector for solvers using SolvVectorIn = typename Parent::SolvVectorIn; //! Input vector for solvers using SolvVectorInC = typename Parent::SolvVectorInC; //! Output vector for solvers using SolvVectorOut = typename Parent::SolvVectorOut; using Cell_t = typename Parent::Cell_t; //!< cell type using Ccoord = typename Parent::Ccoord; //!< cell coordinates type //! kind of tangent that is required using Tg_req_t = typename Parent::TangentRequirement; //! handle for the cell to fit Eigen's sparse matrix interface using Adaptor = typename Cell_t::Adaptor; //! traits obtained from CRTP using DeprecatedSolver = typename internal::DeprecatedSolver_traits< DeprecatedSolverType>::DeprecatedSolver; //! All Eigen solvers need directional stiffness constexpr static Tg_req_t tangent_requirement{Tg_req_t::NeedEffect}; //! Default constructor DeprecatedSolverEigen() = delete; //! Constructor with domain resolutions, etc, - DeprecatedSolverEigen(Cell_t &cell, Real tol, Uint maxiter = 0, + DeprecatedSolverEigen(Cell_t & cell, Real tol, Uint maxiter = 0, bool verbose = false); //! Copy constructor - DeprecatedSolverEigen(const DeprecatedSolverEigen &other) = delete; + DeprecatedSolverEigen(const DeprecatedSolverEigen & other) = delete; //! Move constructor - DeprecatedSolverEigen(DeprecatedSolverEigen &&other) = default; + DeprecatedSolverEigen(DeprecatedSolverEigen && other) = default; //! Destructor virtual ~DeprecatedSolverEigen() = default; //! Copy assignment operator DeprecatedSolverEigen & - operator=(const DeprecatedSolverEigen &other) = delete; + operator=(const DeprecatedSolverEigen & other) = delete; //! Move assignment operator - DeprecatedSolverEigen &operator=(DeprecatedSolverEigen &&other) = default; + DeprecatedSolverEigen & operator=(DeprecatedSolverEigen && other) = default; //! returns whether the solver has converged bool has_converged() const final { return this->solver.info() == Eigen::Success; } //! Allocate fields used during the solution void initialise() final; //! executes the solver - SolvVectorOut solve(const SolvVectorInC rhs, - SolvVectorIn x_0) final; + SolvVectorOut solve(const SolvVectorInC rhs, SolvVectorIn x_0) final; protected: //! returns `muSpectre::Tg_req_t::NeedEffect` Tg_req_t get_tangent_req() const final; Adaptor adaptor; //!< cell handle DeprecatedSolver solver; //!< Eigen's Iterative solver }; /** * Binding to Eigen's conjugate gradient solver */ template class DeprecatedSolverCGEigen : public DeprecatedSolverEigen, DimS, DimM> { public: using DeprecatedSolverEigen, DimS, DimM>::DeprecatedSolverEigen; std::string name() const final { return "CG"; } }; /** * Binding to Eigen's GMRES solver */ template class DeprecatedSolverGMRESEigen : public DeprecatedSolverEigen, DimS, DimM> { public: using DeprecatedSolverEigen, DimS, DimM>::DeprecatedSolverEigen; std::string name() const final { return "GMRES"; } }; /** * Binding to Eigen's BiCGSTAB solver */ template class DeprecatedSolverBiCGSTABEigen : public DeprecatedSolverEigen, DimS, DimM> { public: using DeprecatedSolverEigen, DimS, DimM>::DeprecatedSolverEigen; //! DeprecatedSolver's name std::string name() const final { return "BiCGSTAB"; } }; /** * Binding to Eigen's DGMRES solver */ template class DeprecatedSolverDGMRESEigen : public DeprecatedSolverEigen, DimS, DimM> { public: using DeprecatedSolverEigen, DimS, DimM>::DeprecatedSolverEigen; //! DeprecatedSolver's name std::string name() const final { return "DGMRES"; } }; /** * Binding to Eigen's MINRES solver */ template class DeprecatedSolverMINRESEigen : public DeprecatedSolverEigen, DimS, DimM> { public: using DeprecatedSolverEigen, DimS, DimM>::DeprecatedSolverEigen; //! DeprecatedSolver's name std::string name() const final { return "MINRES"; } }; } // namespace muSpectre #endif // SRC_SOLVER_DEPRECATED_SOLVER_CG_EIGEN_HH_ diff --git a/src/solver/deprecated_solvers.cc b/src/solver/deprecated_solvers.cc index 6eac2b7..349e07d 100644 --- a/src/solver/deprecated_solvers.cc +++ b/src/solver/deprecated_solvers.cc @@ -1,396 +1,396 @@ /** * @file solvers.cc * * @author Till Junge * * @date 20 Dec 2017 * * @brief implementation of solver functions * * Copyright © 2017 Till Junge * * µSpectre 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, 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 Lesser General Public License * along with µSpectre; see the file COPYING. If not, write to the * Free Software Foundation, Inc., 59 Temple Place - Suite 330, * * Boston, MA 02111-1307, USA. * * Additional permission under GNU GPL version 3 section 7 * * If you modify this Program, or any covered work, by linking or combining it * with proprietary FFT implementations or numerical libraries, containing parts * covered by the terms of those libraries' licenses, the licensors of this * Program grant you additional permission to convey the resulting work. */ #include "solver/deprecated_solvers.hh" #include "solver/deprecated_solver_cg.hh" #include "common/iterators.hh" #include #include #include namespace muSpectre { template std::vector - deprecated_de_geus(CellBase &cell, - const GradIncrements &delFs, - DeprecatedSolverBase &solver, Real newton_tol, + deprecated_de_geus(CellBase & cell, + const GradIncrements & delFs, + DeprecatedSolverBase & solver, Real newton_tol, Real equil_tol, Dim_t verbose) { using Field_t = typename MaterialBase::StrainField_t; - const Communicator &comm = cell.get_communicator(); + const Communicator & comm = cell.get_communicator(); auto solver_fields{std::make_unique>()}; solver_fields->initialise(cell.get_subdomain_resolutions(), cell.get_subdomain_locations()); // Corresponds to symbol δF or δε - auto &incrF{make_field("δF", *solver_fields)}; + auto & incrF{make_field("δF", *solver_fields)}; // Corresponds to symbol ΔF or Δε - auto &DeltaF{make_field("ΔF", *solver_fields)}; + auto & DeltaF{make_field("ΔF", *solver_fields)}; // field to store the rhs for cg calculations - auto &rhs{make_field("rhs", *solver_fields)}; + auto & rhs{make_field("rhs", *solver_fields)}; solver.initialise(); if (solver.get_maxiter() == 0) { solver.set_maxiter(cell.size() * DimM * DimM * 10); } size_t count_width{}; const auto form{cell.get_formulation()}; std::string strain_symb{}; if (verbose > 0 && comm.rank() == 0) { // setup of algorithm 5.2 in Nocedal, Numerical Optimization (p. 111) std::cout << "de Geus-" << solver.name() << " for "; switch (form) { case Formulation::small_strain: { strain_symb = "ε"; std::cout << "small"; break; } case Formulation::finite_strain: { strain_symb = "F"; std::cout << "finite"; break; } default: throw SolverError("unknown formulation"); break; } std::cout << " strain with" << std::endl << "newton_tol = " << newton_tol << ", cg_tol = " << solver.get_tol() << " maxiter = " << solver.get_maxiter() << " and Δ" << strain_symb << " =" << std::endl; - for (auto &&tup : akantu::enumerate(delFs)) { - auto &&counter{std::get<0>(tup)}; - auto &&grad{std::get<1>(tup)}; + for (auto && tup : akantu::enumerate(delFs)) { + auto && counter{std::get<0>(tup)}; + auto && grad{std::get<1>(tup)}; std::cout << "Step " << counter + 1 << ":" << std::endl << grad << std::endl; } count_width = size_t(std::log10(solver.get_maxiter())) + 1; } // initialise F = I or ε = 0 - auto &F{cell.get_strain()}; + auto & F{cell.get_strain()}; switch (form) { case Formulation::finite_strain: { F.get_map() = Matrices::I2(); break; } case Formulation::small_strain: { F.get_map() = Matrices::I2().Zero(); - for (const auto &delF : delFs) { + for (const auto & delF : delFs) { if (!check_symmetry(delF)) { throw SolverError("all Δε must be symmetric!"); } } break; } default: throw SolverError("Unknown formulation"); break; } // initialise return value std::vector ret_val{}; Grad_t previous_grad{Grad_t::Zero()}; - for (const auto &delF : delFs) { // incremental loop + for (const auto & delF : delFs) { // incremental loop std::string message{"Has not converged"}; Real incrNorm{2 * newton_tol}, gradNorm{1}; Real stressNorm{2 * equil_tol}; bool has_converged{false}; auto convergence_test = [&incrNorm, &gradNorm, &newton_tol, &stressNorm, &equil_tol, &message, &has_converged]() { bool incr_test = incrNorm / gradNorm <= newton_tol; bool stress_test = stressNorm < equil_tol; if (incr_test) { message = "Residual tolerance reached"; } else if (stress_test) { message = "Reached stress divergence tolerance"; } has_converged = incr_test || stress_test; return has_converged; }; Uint newt_iter{0}; for (; (newt_iter < solver.get_maxiter()) && (!has_converged || (newt_iter == 1)); ++newt_iter) { // obtain material response auto res_tup{cell.evaluate_stress_tangent(F)}; - auto &P{std::get<0>(res_tup)}; - auto &K{std::get<1>(res_tup)}; + auto & P{std::get<0>(res_tup)}; + auto & K{std::get<1>(res_tup)}; - auto tangent_effect = [&cell, &K](const Field_t &dF, Field_t &dP) { + auto tangent_effect = [&cell, &K](const Field_t & dF, Field_t & dP) { cell.directional_stiffness(K, dF, dP); }; if (newt_iter == 0) { DeltaF.get_map() = -(delF - previous_grad); // neg sign because rhs tangent_effect(DeltaF, rhs); stressNorm = std::sqrt(comm.sum(rhs.eigen().matrix().squaredNorm())); if (convergence_test()) { break; } incrF.eigenvec() = solver.solve(rhs.eigenvec(), incrF.eigenvec()); F.eigen() -= DeltaF.eigen(); } else { rhs.eigen() = -P.eigen(); cell.project(rhs); stressNorm = std::sqrt(comm.sum(rhs.eigen().matrix().squaredNorm())); if (convergence_test()) { break; } incrF.eigen() = 0; incrF.eigenvec() = solver.solve(rhs.eigenvec(), incrF.eigenvec()); } F.eigen() += incrF.eigen(); incrNorm = std::sqrt(comm.sum(incrF.eigen().matrix().squaredNorm())); gradNorm = std::sqrt(comm.sum(F.eigen().matrix().squaredNorm())); if (verbose > 0 && comm.rank() == 0) { std::cout << "at Newton step " << std::setw(count_width) << newt_iter << ", |δ" << strain_symb << "|/|Δ" << strain_symb << "| = " << std::setw(17) << incrNorm / gradNorm << ", tol = " << newton_tol << std::endl; if (verbose - 1 > 1) { std::cout << "<" << strain_symb << "> =" << std::endl << F.get_map().mean() << std::endl; } } convergence_test(); } // update previous gradient previous_grad = delF; ret_val.push_back(OptimizeResult{ F.eigen(), cell.get_stress().eigen(), has_converged, Int(has_converged), message, newt_iter, solver.get_counter()}); // store history variables here cell.save_history_variables(); } return ret_val; } //! instantiation for two-dimensional cells template std::vector - deprecated_de_geus(CellBase &cell, - const GradIncrements &delF0, - DeprecatedSolverBase &solver, Real newton_tol, + deprecated_de_geus(CellBase & cell, + const GradIncrements & delF0, + DeprecatedSolverBase & solver, Real newton_tol, Real equil_tol, Dim_t verbose); //! instantiation for three-dimensional cells template std::vector - deprecated_de_geus(CellBase &cell, - const GradIncrements &delF0, - DeprecatedSolverBase &solver, + deprecated_de_geus(CellBase & cell, + const GradIncrements & delF0, + DeprecatedSolverBase & solver, Real newton_tol, Real equil_tol, Dim_t verbose); /* ---------------------------------------------------------------------- */ template std::vector - deprecated_newton_cg(CellBase &cell, - const GradIncrements &delFs, - DeprecatedSolverBase &solver, + deprecated_newton_cg(CellBase & cell, + const GradIncrements & delFs, + DeprecatedSolverBase & solver, Real newton_tol, Real equil_tol, Dim_t verbose) { using Field_t = typename MaterialBase::StrainField_t; - const Communicator &comm = cell.get_communicator(); + const Communicator & comm = cell.get_communicator(); auto solver_fields{std::make_unique>()}; solver_fields->initialise(cell.get_subdomain_resolutions(), cell.get_subdomain_locations()); // Corresponds to symbol δF or δε - auto &incrF{make_field("δF", *solver_fields)}; + auto & incrF{make_field("δF", *solver_fields)}; // field to store the rhs for cg calculations - auto &rhs{make_field("rhs", *solver_fields)}; + auto & rhs{make_field("rhs", *solver_fields)}; solver.initialise(); if (solver.get_maxiter() == 0) { solver.set_maxiter(cell.size() * DimM * DimM * 10); } size_t count_width{}; const auto form{cell.get_formulation()}; std::string strain_symb{}; if (verbose > 0 && comm.rank() == 0) { // setup of algorithm 5.2 in Nocedal, Numerical Optimization (p. 111) std::cout << "Newton-" << solver.name() << " for "; switch (form) { case Formulation::small_strain: { strain_symb = "ε"; std::cout << "small"; break; } case Formulation::finite_strain: { strain_symb = "F"; std::cout << "finite"; break; } default: throw SolverError("unknown formulation"); break; } std::cout << " strain with" << std::endl << "newton_tol = " << newton_tol << ", cg_tol = " << solver.get_tol() << " maxiter = " << solver.get_maxiter() << " and Δ" << strain_symb << " =" << std::endl; - for (auto &&tup : akantu::enumerate(delFs)) { - auto &&counter{std::get<0>(tup)}; - auto &&grad{std::get<1>(tup)}; + for (auto && tup : akantu::enumerate(delFs)) { + auto && counter{std::get<0>(tup)}; + auto && grad{std::get<1>(tup)}; std::cout << "Step " << counter + 1 << ":" << std::endl << grad << std::endl; } count_width = size_t(std::log10(solver.get_maxiter())) + 1; } // initialise F = I or ε = 0 - auto &F{cell.get_strain()}; + auto & F{cell.get_strain()}; switch (cell.get_formulation()) { case Formulation::finite_strain: { F.get_map() = Matrices::I2(); break; } case Formulation::small_strain: { F.get_map() = Matrices::I2().Zero(); - for (const auto &delF : delFs) { + for (const auto & delF : delFs) { if (!check_symmetry(delF)) { throw SolverError("all Δε must be symmetric!"); } } break; } default: throw SolverError("Unknown formulation"); break; } // initialise return value std::vector ret_val{}; Grad_t previous_grad{Grad_t::Zero()}; - for (const auto &delF : delFs) { // incremental loop + for (const auto & delF : delFs) { // incremental loop // apply macroscopic strain increment - for (auto &&grad : F.get_map()) { + for (auto && grad : F.get_map()) { grad += delF - previous_grad; } std::string message{"Has not converged"}; Real incrNorm{2 * newton_tol}, gradNorm{1}; Real stressNorm{2 * equil_tol}; bool has_converged{false}; auto convergence_test = [&incrNorm, &gradNorm, &newton_tol, &stressNorm, &equil_tol, &message, &has_converged]() { bool incr_test = incrNorm / gradNorm <= newton_tol; bool stress_test = stressNorm < equil_tol; if (incr_test) { message = "Residual tolerance reached"; } else if (stress_test) { message = "Reached stress divergence tolerance"; } has_converged = incr_test || stress_test; return has_converged; }; Uint newt_iter{0}; for (; newt_iter < solver.get_maxiter() && !has_converged; ++newt_iter) { // obtain material response auto res_tup{cell.evaluate_stress_tangent(F)}; - auto &P{std::get<0>(res_tup)}; + auto & P{std::get<0>(res_tup)}; rhs.eigen() = -P.eigen(); cell.project(rhs); stressNorm = std::sqrt(comm.sum(rhs.eigen().matrix().squaredNorm())); if (convergence_test()) { break; } incrF.eigen() = 0; incrF.eigenvec() = solver.solve(rhs.eigenvec(), incrF.eigenvec()); F.eigen() += incrF.eigen(); incrNorm = std::sqrt(comm.sum(incrF.eigen().matrix().squaredNorm())); gradNorm = std::sqrt(comm.sum(F.eigen().matrix().squaredNorm())); if (verbose > 0 && comm.rank() == 0) { std::cout << "at Newton step " << std::setw(count_width) << newt_iter << ", |δ" << strain_symb << "|/|Δ" << strain_symb << "| = " << std::setw(17) << incrNorm / gradNorm << ", tol = " << newton_tol << std::endl; if (verbose - 1 > 1) { std::cout << "<" << strain_symb << "> =" << std::endl << F.get_map().mean() << std::endl; } } convergence_test(); } // update previous gradient previous_grad = delF; ret_val.push_back(OptimizeResult{ F.eigen(), cell.get_stress().eigen(), convergence_test(), Int(convergence_test()), message, newt_iter, solver.get_counter()}); // store history variables for next load increment cell.save_history_variables(); } return ret_val; } //! instantiation for two-dimensional cells template std::vector - deprecated_newton_cg(CellBase &cell, - const GradIncrements &delF0, - DeprecatedSolverBase &solver, + deprecated_newton_cg(CellBase & cell, + const GradIncrements & delF0, + DeprecatedSolverBase & solver, Real newton_tol, Real equil_tol, Dim_t verbose); //! instantiation for three-dimensional cells template std::vector - deprecated_newton_cg(CellBase &cell, - const GradIncrements &delF0, - DeprecatedSolverBase &solver, + deprecated_newton_cg(CellBase & cell, + const GradIncrements & delF0, + DeprecatedSolverBase & solver, Real newton_tol, Real equil_tol, Dim_t verbose); } // namespace muSpectre diff --git a/src/solver/deprecated_solvers.hh b/src/solver/deprecated_solvers.hh index d6f6e99..b29ce94 100644 --- a/src/solver/deprecated_solvers.hh +++ b/src/solver/deprecated_solvers.hh @@ -1,102 +1,102 @@ /** * @file solvers.hh * * @author Till Junge * * @date 20 Dec 2017 * * @brief Free functions for solving * * Copyright © 2017 Till Junge * * µSpectre 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, 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 Lesser General Public License * along with µSpectre; see the file COPYING. If not, write to the * Free Software Foundation, Inc., 59 Temple Place - Suite 330, * * Boston, MA 02111-1307, USA. * * Additional permission under GNU GPL version 3 section 7 * * If you modify this Program, or any covered work, by linking or combining it * with proprietary FFT implementations or numerical libraries, containing parts * covered by the terms of those libraries' licenses, the licensors of this * Program grant you additional permission to convey the resulting work. */ #ifndef SRC_SOLVER_DEPRECATED_SOLVERS_HH_ #define SRC_SOLVER_DEPRECATED_SOLVERS_HH_ #include "solver/solver_common.hh" #include "solver/deprecated_solver_base.hh" #include #include #include namespace muSpectre { /* ---------------------------------------------------------------------- */ /** * Uses the Newton-conjugate Gradient method to find the static * equilibrium of a cell given a series of mean applied strains */ template std::vector - deprecated_newton_cg(CellBase &cell, - const GradIncrements &delF0, - DeprecatedSolverBase &solver, + deprecated_newton_cg(CellBase & cell, + const GradIncrements & delF0, + DeprecatedSolverBase & solver, Real newton_tol, Real equil_tol, Dim_t verbose = 0); /* ---------------------------------------------------------------------- */ /** * Uses the Newton-conjugate Gradient method to find the static * equilibrium of a cell given a mean applied strain */ template inline OptimizeResult - deprecated_newton_cg(CellBase &cell, const Grad_t &delF0, - DeprecatedSolverBase &solver, + deprecated_newton_cg(CellBase & cell, const Grad_t & delF0, + DeprecatedSolverBase & solver, Real newton_tol, Real equil_tol, Dim_t verbose = 0) { return deprecated_newton_cg(cell, GradIncrements{delF0}, solver, newton_tol, equil_tol, verbose)[0]; } /* ---------------------------------------------------------------------- */ /** * Uses the method proposed by de Geus method to find the static * equilibrium of a cell given a series of mean applied strains */ template std::vector - deprecated_de_geus(CellBase &cell, - const GradIncrements &delF0, - DeprecatedSolverBase &solver, Real newton_tol, + deprecated_de_geus(CellBase & cell, + const GradIncrements & delF0, + DeprecatedSolverBase & solver, Real newton_tol, Real equil_tol, Dim_t verbose = 0); /* ---------------------------------------------------------------------- */ /** * Uses the method proposed by de Geus method to find the static * equilibrium of a cell given a mean applied strain */ template OptimizeResult - deprecated_de_geus(CellBase &cell, const Grad_t &delF0, - DeprecatedSolverBase &solver, Real newton_tol, + deprecated_de_geus(CellBase & cell, const Grad_t & delF0, + DeprecatedSolverBase & solver, Real newton_tol, Real equil_tol, Dim_t verbose = 0) { return deprecated_de_geus(cell, GradIncrements{delF0}, solver, newton_tol, equil_tol, verbose)[0]; } } // namespace muSpectre #endif // SRC_SOLVER_DEPRECATED_SOLVERS_HH_ diff --git a/src/solver/solver_base.cc b/src/solver/solver_base.cc index 7692e8e..2a14a20 100644 --- a/src/solver/solver_base.cc +++ b/src/solver/solver_base.cc @@ -1,61 +1,61 @@ /** * file solver_base.cc * * @author Till Junge * * @date 24 Apr 2018 * * @brief implementation of SolverBase * * Copyright © 2018 Till Junge * * µSpectre 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, 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 Lesser General Public License * along with µSpectre; see the file COPYING. If not, write to the * Free Software Foundation, Inc., 59 Temple Place - Suite 330, * * Boston, MA 02111-1307, USA. * * Additional permission under GNU GPL version 3 section 7 * * If you modify this Program, or any covered work, by linking or combining it * with proprietary FFT implementations or numerical libraries, containing parts * covered by the terms of those libraries' licenses, the licensors of this * Program grant you additional permission to convey the resulting work. */ #include "solver/solver_base.hh" namespace muSpectre { /* ---------------------------------------------------------------------- */ - SolverBase::SolverBase(Cell &cell, Real tol, Uint maxiter, bool verbose) + SolverBase::SolverBase(Cell & cell, Real tol, Uint maxiter, bool verbose) : cell(cell), tol{tol}, maxiter{maxiter}, verbose{verbose} {} /* ---------------------------------------------------------------------- */ bool SolverBase::has_converged() const { return this->converged; } /* ---------------------------------------------------------------------- */ void SolverBase::reset_counter() { this->counter = 0; this->converged = false; } /* ---------------------------------------------------------------------- */ Uint SolverBase::get_counter() const { return this->counter; } /* ---------------------------------------------------------------------- */ Real SolverBase::get_tol() const { return this->tol; } /* ---------------------------------------------------------------------- */ Uint SolverBase::get_maxiter() const { return this->maxiter; } } // namespace muSpectre diff --git a/src/solver/solver_base.hh b/src/solver/solver_base.hh index b392a5c..e51e0f1 100644 --- a/src/solver/solver_base.hh +++ b/src/solver/solver_base.hh @@ -1,122 +1,122 @@ /** * file solver_base.hh * * @author Till Junge * * @date 24 Apr 2018 * * @brief Base class for iterative solvers for linear systems of equations * * Copyright © 2018 Till Junge * * µSpectre 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, 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 Lesser General Public License * along with µSpectre; see the file COPYING. If not, write to the * Free Software Foundation, Inc., 59 Temple Place - Suite 330, * * Boston, MA 02111-1307, USA. * * Additional permission under GNU GPL version 3 section 7 * * If you modify this Program, or any covered work, by linking or combining it * with proprietary FFT implementations or numerical libraries, containing parts * covered by the terms of those libraries' licenses, the licensors of this * Program grant you additional permission to convey the resulting work. */ #ifndef SRC_SOLVER_SOLVER_BASE_HH_ #define SRC_SOLVER_SOLVER_BASE_HH_ #include "solver/solver_common.hh" #include "cell/cell_base.hh" #include namespace muSpectre { /** * Virtual base class for solvers. An implementation of this interface * can be used with the solution strategies in solvers.hh */ class SolverBase { public: //! underlying vector type using Vector_t = Eigen::Matrix; //! Input vector for solvers using Vector_ref = Eigen::Ref; //! Input vector for solvers using ConstVector_ref = Eigen::Ref; //! Output vector for solvers using Vector_map = Eigen::Map; //! Default constructor SolverBase() = delete; /** * Constructor takes a Cell, tolerance, max number of iterations * and verbosity flag as input */ - SolverBase(Cell &cell, Real tol, Uint maxiter, bool verbose = false); + SolverBase(Cell & cell, Real tol, Uint maxiter, bool verbose = false); //! Copy constructor - SolverBase(const SolverBase &other) = delete; + SolverBase(const SolverBase & other) = delete; //! Move constructor - SolverBase(SolverBase &&other) = default; + SolverBase(SolverBase && other) = default; //! Destructor virtual ~SolverBase() = default; //! Copy assignment operator - SolverBase &operator=(const SolverBase &other) = delete; + SolverBase & operator=(const SolverBase & other) = delete; //! Move assignment operator - SolverBase &operator=(SolverBase &&other) = default; + SolverBase & operator=(SolverBase && other) = default; //! Allocate fields used during the solution virtual void initialise() = 0; //! returns whether the solver has converged bool has_converged() const; //! reset the iteration counter to zero void reset_counter(); //! get the count of how many solve steps have been executed since //! construction of most recent counter reset Uint get_counter() const; //! returns the max number of iterations Uint get_maxiter() const; //! returns the resolution tolerance Real get_tol() const; //! returns the solver's name (i.e. 'CG', 'GMRES', etc) virtual std::string get_name() const = 0; //! run the solve operation virtual Vector_map solve(const ConstVector_ref rhs) = 0; protected: - Cell &cell; //!< reference to the problem's cell + Cell & cell; //!< reference to the problem's cell Real tol; //!< convergence tolerance Uint maxiter; //!< maximum allowed number of iterations bool verbose; //!< whether to write information to the stdout Uint counter{0}; //!< iteration counter bool converged{false}; //!< whether the solver has converged private: }; } // namespace muSpectre #endif // SRC_SOLVER_SOLVER_BASE_HH_ diff --git a/src/solver/solver_cg.cc b/src/solver/solver_cg.cc index dff3d90..88ae0ce 100644 --- a/src/solver/solver_cg.cc +++ b/src/solver/solver_cg.cc @@ -1,110 +1,110 @@ /** * file solver_cg.cc * * @author Till Junge * * @date 24 Apr 2018 * * @brief implements SolverCG * * Copyright © 2018 Till Junge * * µSpectre 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, 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 Lesser General Public License * along with µSpectre; see the file COPYING. If not, write to the * Free Software Foundation, Inc., 59 Temple Place - Suite 330, * * Boston, MA 02111-1307, USA. * * Additional permission under GNU GPL version 3 section 7 * * If you modify this Program, or any covered work, by linking or combining it * with proprietary FFT implementations or numerical libraries, containing parts * covered by the terms of those libraries' licenses, the licensors of this * Program grant you additional permission to convey the resulting work. */ #include "solver/solver_cg.hh" #include "common/communicator.hh" #include #include namespace muSpectre { /* ---------------------------------------------------------------------- */ - SolverCG::SolverCG(Cell &cell, Real tol, Uint maxiter, bool verbose) + SolverCG::SolverCG(Cell & cell, Real tol, Uint maxiter, bool verbose) : Parent(cell, tol, maxiter, verbose), r_k(cell.get_nb_dof()), p_k(cell.get_nb_dof()), Ap_k(cell.get_nb_dof()), x_k(cell.get_nb_dof()) {} /* ---------------------------------------------------------------------- */ auto SolverCG::solve(const ConstVector_ref rhs) -> Vector_map { this->x_k.setZero(); - const Communicator &comm = this->cell.get_communicator(); + const Communicator & comm = this->cell.get_communicator(); // Following implementation of algorithm 5.2 in Nocedal's // Numerical Optimization (p. 112) // initialisation of algorithm this->r_k = (this->cell.evaluate_projected_directional_stiffness(this->x_k) - rhs); this->p_k = -this->r_k; this->converged = false; Real rdr = comm.sum(this->r_k.dot(this->r_k)); Real rhs_norm2 = comm.sum(rhs.squaredNorm()); Real tol2 = ipow(this->tol, 2) * rhs_norm2; 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 == 0); ++i, ++this->counter) { this->Ap_k = this->cell.evaluate_projected_directional_stiffness(this->p_k); Real alpha = rdr / comm.sum(this->p_k.dot(this->Ap_k)); this->x_k += alpha * this->p_k; this->r_k += alpha * this->Ap_k; Real new_rdr = comm.sum(this->r_k.dot(this->r_k)); Real beta = new_rdr / rdr; rdr = new_rdr; if (this->verbose && comm.rank() == 0) { std::cout << " at CG step " << std::setw(count_width) << i << ": |r|/|b| = " << std::setw(15) << std::sqrt(rdr / rhs_norm2) << ", cg_tol = " << this->tol << std::endl; } this->p_k = -this->r_k + beta * this->p_k; } if (rdr < tol2) { this->converged = true; } else { std::stringstream err{}; err << " After " << this->counter << " steps, the solver " << " FAILED with |r|/|b| = " << std::setw(15) << std::sqrt(rdr / rhs_norm2) << ", cg_tol = " << this->tol << std::endl; throw ConvergenceError("Conjugate gradient has not converged." + err.str()); } return Vector_map(this->x_k.data(), this->x_k.size()); } } // namespace muSpectre diff --git a/src/solver/solver_cg.hh b/src/solver/solver_cg.hh index 25d6e58..eb613fb 100644 --- a/src/solver/solver_cg.hh +++ b/src/solver/solver_cg.hh @@ -1,107 +1,107 @@ /** * file solver_cg.hh * * @author Till Junge * * @date 24 Apr 2018 * * @brief class fo a simple implementation of a conjugate gradient solver. * This follows algorithm 5.2 in Nocedal's Numerical Optimization * (p 112) * * Copyright © 2018 Till Junge * * µSpectre 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, 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 Lesser General Public License * along with µSpectre; see the file COPYING. If not, write to the * Free Software Foundation, Inc., 59 Temple Place - Suite 330, * * Boston, MA 02111-1307, USA. * * Additional permission under GNU GPL version 3 section 7 * * If you modify this Program, or any covered work, by linking or combining it * with proprietary FFT implementations or numerical libraries, containing parts * covered by the terms of those libraries' licenses, the licensors of this * Program grant you additional permission to convey the resulting work. */ #ifndef SRC_SOLVER_SOLVER_CG_HH_ #define SRC_SOLVER_SOLVER_CG_HH_ #include "solver/solver_base.hh" namespace muSpectre { /** * implements the `muSpectre::SolverBase` interface using a * conjugate gradient solver. This particular class is useful for * trouble shooting, as it can be made very verbose, but for * production runs, it is probably better to use * `muSpectre::SolverCGEigen`. */ class SolverCG : public SolverBase { public: using Parent = SolverBase; //!< standard short-hand for base class //! for storage of fields using Vector_t = Parent::Vector_t; //! Input vector for solvers using Vector_ref = Parent::Vector_ref; //! Input vector for solvers using ConstVector_ref = Parent::ConstVector_ref; //! Output vector for solvers using Vector_map = Parent::Vector_map; //! Default constructor SolverCG() = delete; //! Copy constructor - SolverCG(const SolverCG &other) = delete; + SolverCG(const SolverCG & other) = delete; /** * Constructor takes a Cell, tolerance, max number of iterations * and verbosity flag as input */ - SolverCG(Cell &cell, Real tol, Uint maxiter, bool verbose = false); + SolverCG(Cell & cell, Real tol, Uint maxiter, bool verbose = false); //! Move constructor - SolverCG(SolverCG &&other) = default; + SolverCG(SolverCG && other) = default; //! Destructor virtual ~SolverCG() = default; //! Copy assignment operator - SolverCG &operator=(const SolverCG &other) = delete; + SolverCG & operator=(const SolverCG & other) = delete; //! Move assignment operator - SolverCG &operator=(SolverCG &&other) = default; + SolverCG & operator=(SolverCG && other) = default; //! initialisation does not need to do anything in this case void initialise() final{}; //! returns the solver's name std::string get_name() const final { return "CG"; } //! the actual solver Vector_map solve(const ConstVector_ref rhs) final; protected: Vector_t r_k; //!< residual Vector_t p_k; //!< search direction Vector_t Ap_k; //!< directional stiffness Vector_t x_k; //!< current solution private: }; } // namespace muSpectre #endif // SRC_SOLVER_SOLVER_CG_HH_ diff --git a/src/solver/solver_common.cc b/src/solver/solver_common.cc index 8a9214f..d3a35db 100644 --- a/src/solver/solver_common.cc +++ b/src/solver/solver_common.cc @@ -1,46 +1,46 @@ /** * file solver_common.cc * * @author Till Junge * * @date 15 May 2018 * * @brief implementation for solver utilities * * Copyright © 2018 Till Junge * * µSpectre 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, 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 Lesser General Public License * along with µSpectre; see the file COPYING. If not, write to the * Free Software Foundation, Inc., 59 Temple Place - Suite 330, * * Boston, MA 02111-1307, USA. * * Additional permission under GNU GPL version 3 section 7 * * If you modify this Program, or any covered work, by linking or combining it * with proprietary FFT implementations or numerical libraries, containing parts * covered by the terms of those libraries' licenses, the licensors of this * Program grant you additional permission to convey the resulting work. */ #include "solver/solver_common.hh" namespace muSpectre { /* ---------------------------------------------------------------------- */ - bool check_symmetry(const Eigen::Ref &eps, + bool check_symmetry(const Eigen::Ref & eps, Real rel_tol) { return (rel_tol >= (eps - eps.transpose()).matrix().norm() / eps.matrix().norm() || rel_tol >= eps.matrix().norm()); } } // namespace muSpectre diff --git a/src/solver/solver_common.hh b/src/solver/solver_common.hh index 1263809..812278b 100644 --- a/src/solver/solver_common.hh +++ b/src/solver/solver_common.hh @@ -1,100 +1,101 @@ /** * @file solver_common.hh * * @author Till Junge * * @date 28 Dec 2017 * * @brief Errors raised by solvers and other common utilities * * Copyright © 2017 Till Junge * * µSpectre 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, 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 Lesser General Public License * along with µSpectre; see the file COPYING. If not, write to the * Free Software Foundation, Inc., 59 Temple Place - Suite 330, * * Boston, MA 02111-1307, USA. * * Additional permission under GNU GPL version 3 section 7 * * If you modify this Program, or any covered work, by linking or combining it * with proprietary FFT implementations or numerical libraries, containing parts * covered by the terms of those libraries' licenses, the licensors of this * Program grant you additional permission to convey the resulting work. */ #ifndef SRC_SOLVER_SOLVER_COMMON_HH_ #define SRC_SOLVER_SOLVER_COMMON_HH_ #include "common/common.hh" #include "common/tensor_algebra.hh" #include #include namespace muSpectre { /** * emulates scipy.optimize.OptimizeResult */ struct OptimizeResult { //! Strain ε or Gradient F at solution Eigen::ArrayXXd grad; //! Cauchy stress σ or first Piola-Kirchhoff stress P at solution Eigen::ArrayXXd stress; //! whether or not the solver exited successfully bool success; //! Termination status of the optimizer. Its value depends on the //! underlying solver. Refer to message for details. Int status; //! Description of the cause of the termination. std::string message; //! number of iterations Uint nb_it; //! number of cell evaluations Uint nb_fev; }; /** * Field type that solvers expect gradients to be expressed in */ - template using Grad_t = Matrices::Tens2_t; + template + using Grad_t = Matrices::Tens2_t; /** * multiple increments can be submitted at once (useful for * path-dependent materials) */ template using GradIncrements = std::vector, Eigen::aligned_allocator>>; /* ---------------------------------------------------------------------- */ class SolverError : public std::runtime_error { using runtime_error::runtime_error; }; /* ---------------------------------------------------------------------- */ class ConvergenceError : public SolverError { using SolverError::SolverError; }; /* ---------------------------------------------------------------------- */ /** * check whether a strain is symmetric, for the purposes of small * strain problems */ - bool check_symmetry(const Eigen::Ref &eps, + bool check_symmetry(const Eigen::Ref & eps, Real rel_tol = 1e-8); } // namespace muSpectre #endif // SRC_SOLVER_SOLVER_COMMON_HH_ diff --git a/src/solver/solver_eigen.cc b/src/solver/solver_eigen.cc index 87fb4cc..a3d6aa7 100644 --- a/src/solver/solver_eigen.cc +++ b/src/solver/solver_eigen.cc @@ -1,89 +1,90 @@ /** * file solver_eigen.cc * * @author Till Junge * * @date 15 May 2018 * * @brief Implementations for bindings to Eigen's iterative solvers * * Copyright © 2018 Till Junge * * µSpectre 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, 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 Lesser General Public License * along with µSpectre; see the file COPYING. If not, write to the * Free Software Foundation, Inc., 59 Temple Place - Suite 330, * * Boston, MA 02111-1307, USA. * * Additional permission under GNU GPL version 3 section 7 * * If you modify this Program, or any covered work, by linking or combining it * with proprietary FFT implementations or numerical libraries, containing parts * covered by the terms of those libraries' licenses, the licensors of this * Program grant you additional permission to convey the resulting work. */ #include "solver/solver_eigen.hh" #include #include namespace muSpectre { /* ---------------------------------------------------------------------- */ template - SolverEigen::SolverEigen(Cell &cell, Real tol, Uint maxiter, + SolverEigen::SolverEigen(Cell & cell, Real tol, Uint maxiter, bool verbose) : Parent(cell, tol, maxiter, verbose), adaptor{cell.get_adaptor()}, solver{}, result{} {} /* ---------------------------------------------------------------------- */ - template void SolverEigen::initialise() { + template + void SolverEigen::initialise() { this->solver.setTolerance(this->get_tol()); this->solver.setMaxIterations(this->get_maxiter()); this->solver.compute(this->adaptor); } /* ---------------------------------------------------------------------- */ template auto SolverEigen::solve(const ConstVector_ref rhs) -> Vector_map { // for crtp - auto &this_solver = static_cast(*this); + auto & this_solver = static_cast(*this); this->result = this->solver.solve(rhs); this->counter += this->solver.iterations(); if (this->solver.info() != Eigen::Success) { std::stringstream err{}; err << this_solver.get_name() << " has not converged," << " After " << this->solver.iterations() << " steps, the solver " << " FAILED with |r|/|b| = " << std::setw(15) << this->solver.error() << ", cg_tol = " << this->tol << std::endl; throw ConvergenceError(err.str()); } if (this->verbose) { std::cout << " After " << this->solver.iterations() << " " << this_solver.get_name() << " steps, |r|/|b| = " << std::setw(15) << this->solver.error() << ", cg_tol = " << this->tol << std::endl; } return Vector_map(this->result.data(), this->result.size()); } /* ---------------------------------------------------------------------- */ template class SolverEigen; template class SolverEigen; template class SolverEigen; template class SolverEigen; template class SolverEigen; } // namespace muSpectre diff --git a/src/solver/solver_eigen.hh b/src/solver/solver_eigen.hh index e90eadd..d2b43ba 100644 --- a/src/solver/solver_eigen.hh +++ b/src/solver/solver_eigen.hh @@ -1,199 +1,207 @@ /** * file solver_eigen.hh * * @author Till Junge * * @date 15 May 2018 * * @brief Bindings to Eigen's iterative solvers * * Copyright © 2018 Till Junge * * µSpectre 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, 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 Lesser General Public License * along with µSpectre; see the file COPYING. If not, write to the * Free Software Foundation, Inc., 59 Temple Place - Suite 330, * * Boston, MA 02111-1307, USA. * * Additional permission under GNU GPL version 3 section 7 * * If you modify this Program, or any covered work, by linking or combining it * with proprietary FFT implementations or numerical libraries, containing parts * covered by the terms of those libraries' licenses, the licensors of this * Program grant you additional permission to convey the resulting work. */ #ifndef SRC_SOLVER_SOLVER_EIGEN_HH_ #define SRC_SOLVER_SOLVER_EIGEN_HH_ #include "solver/solver_base.hh" #include "cell/cell_base.hh" #include #include namespace muSpectre { - template class SolverEigen; + template + class SolverEigen; class SolverCGEigen; class SolverGMRESEigen; class SolverBiCGSTABEigen; class SolverDGMRESEigen; class SolverMINRESEigen; namespace internal { - template struct Solver_traits {}; + template + struct Solver_traits {}; //! traits for the Eigen conjugate gradient solver - template <> struct Solver_traits { + template <> + struct Solver_traits { //! Eigen Iterative Solver using Solver = Eigen::ConjugateGradient; }; //! traits for the Eigen GMRES solver - template <> struct Solver_traits { + template <> + struct Solver_traits { //! Eigen Iterative Solver using Solver = Eigen::GMRES; }; //! traits for the Eigen BiCGSTAB solver - template <> struct Solver_traits { + template <> + struct Solver_traits { //! Eigen Iterative Solver using Solver = Eigen::BiCGSTAB; }; //! traits for the Eigen DGMRES solver - template <> struct Solver_traits { + template <> + struct Solver_traits { //! Eigen Iterative Solver using Solver = Eigen::DGMRES; }; //! traits for the Eigen MINRES solver - template <> struct Solver_traits { + template <> + struct Solver_traits { //! Eigen Iterative Solver using Solver = Eigen::MINRES; }; } // namespace internal /** * base class for iterative solvers from Eigen */ - template class SolverEigen : public SolverBase { + template + class SolverEigen : public SolverBase { public: using Parent = SolverBase; //!< base class //! traits obtained from CRTP using Solver = typename internal::Solver_traits::Solver; //! Input vectors for solver using ConstVector_ref = Parent::ConstVector_ref; //! Output vector for solver using Vector_map = Parent::Vector_map; //! storage for output vector using Vector_t = Parent::Vector_t; //! Default constructor SolverEigen() = delete; //! Constructor with domain resolutions, etc, - SolverEigen(Cell &cell, Real tol, Uint maxiter = 0, bool verbose = false); + SolverEigen(Cell & cell, Real tol, Uint maxiter = 0, bool verbose = false); //! Copy constructor - SolverEigen(const SolverEigen &other) = delete; + SolverEigen(const SolverEigen & other) = delete; //! Move constructor - SolverEigen(SolverEigen &&other) = default; + SolverEigen(SolverEigen && other) = default; //! Destructor virtual ~SolverEigen() = default; //! Copy assignment operator - SolverEigen &operator=(const SolverEigen &other) = delete; + SolverEigen & operator=(const SolverEigen & other) = delete; //! Move assignment operator - SolverEigen &operator=(SolverEigen &&other) = default; + SolverEigen & operator=(SolverEigen && other) = default; //! Allocate fields used during the solution void initialise() final; //! executes the solver Vector_map solve(const ConstVector_ref rhs) final; protected: Cell::Adaptor adaptor; //!< cell handle Solver solver; //!< Eigen's Iterative solver Vector_t result; //!< storage for result }; /** * Binding to Eigen's conjugate gradient solver */ class SolverCGEigen : public SolverEigen { public: using SolverEigen::SolverEigen; std::string get_name() const final { return "CG"; } }; /** * Binding to Eigen's GMRES solver */ class SolverGMRESEigen : public SolverEigen { public: using SolverEigen::SolverEigen; std::string get_name() const final { return "GMRES"; } }; /** * Binding to Eigen's BiCGSTAB solver */ class SolverBiCGSTABEigen : public SolverEigen { public: using SolverEigen::SolverEigen; //! Solver's name std::string get_name() const final { return "BiCGSTAB"; } }; /** * Binding to Eigen's DGMRES solver */ class SolverDGMRESEigen : public SolverEigen { public: using SolverEigen::SolverEigen; //! Solver's name std::string get_name() const final { return "DGMRES"; } }; /** * Binding to Eigen's MINRES solver */ class SolverMINRESEigen : public SolverEigen { public: using SolverEigen::SolverEigen; //! Solver's name std::string get_name() const final { return "MINRES"; } }; } // namespace muSpectre #endif // SRC_SOLVER_SOLVER_EIGEN_HH_ diff --git a/src/solver/solvers.cc b/src/solver/solvers.cc index 24b74f4..29be80a 100644 --- a/src/solver/solvers.cc +++ b/src/solver/solvers.cc @@ -1,406 +1,407 @@ /** * file solvers.cc * * @author Till Junge * * @date 24 Apr 2018 * * @brief implementation of dynamic newton-cg solver * * Copyright © 2018 Till Junge * * µSpectre 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, 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 Lesser General Public License * along with µSpectre; see the file COPYING. If not, write to the * Free Software Foundation, Inc., 59 Temple Place - Suite 330, * * Boston, MA 02111-1307, USA. * * Additional permission under GNU GPL version 3 section 7 * * If you modify this Program, or any covered work, by linking or combining it * with proprietary FFT implementations or numerical libraries, containing parts * covered by the terms of those libraries' licenses, the licensors of this * Program grant you additional permission to convey the resulting work. */ #include "solvers.hh" #include #include namespace muSpectre { //----------------------------------------------------------------------------// - std::vector newton_cg(Cell &cell, - const LoadSteps_t &load_steps, - SolverBase &solver, Real newton_tol, + std::vector newton_cg(Cell & cell, + const LoadSteps_t & load_steps, + SolverBase & solver, Real newton_tol, Real equil_tol, Dim_t verbose) { - const Communicator &comm = cell.get_communicator(); + const Communicator & comm = cell.get_communicator(); using Vector_t = Eigen::Matrix; using Matrix_t = Eigen::Matrix; // Corresponds to symbol δF or δε Vector_t incrF(cell.get_nb_dof()); // field to store the rhs for cg calculations Vector_t rhs(cell.get_nb_dof()); solver.initialise(); size_t count_width{}; const auto form{cell.get_formulation()}; std::string strain_symb{}; if (verbose > 0 && comm.rank() == 0) { // setup of algorithm 5.2 in Nocedal, Numerical Optimization (p. 111) std::cout << "Newton-" << solver.get_name() << " for "; switch (form) { case Formulation::small_strain: { strain_symb = "ε"; std::cout << "small"; break; } case Formulation::finite_strain: { strain_symb = "F"; std::cout << "finite"; break; } default: throw SolverError("unknown formulation"); break; } std::cout << " strain with" << std::endl << "newton_tol = " << newton_tol << ", cg_tol = " << solver.get_tol() << " maxiter = " << solver.get_maxiter() << " and Δ" << strain_symb << " =" << std::endl; - for (auto &&tup : akantu::enumerate(load_steps)) { - auto &&counter{std::get<0>(tup)}; - auto &&grad{std::get<1>(tup)}; + for (auto && tup : akantu::enumerate(load_steps)) { + auto && counter{std::get<0>(tup)}; + auto && grad{std::get<1>(tup)}; std::cout << "Step " << counter + 1 << ":" << std::endl << grad << std::endl; } count_width = size_t(std::log10(solver.get_maxiter())) + 1; } auto shape{cell.get_strain_shape()}; switch (form) { case Formulation::finite_strain: { cell.set_uniform_strain(Matrix_t::Identity(shape[0], shape[1])); - for (const auto &delF : load_steps) { - if (not((delF.rows() == shape[0]) and(delF.cols() == shape[1]))) { + for (const auto & delF : load_steps) { + if (not((delF.rows() == shape[0]) and (delF.cols() == shape[1]))) { std::stringstream err{}; err << "Load increments need to be given in " << shape[0] << "×" << shape[1] << " matrices, but I got a " << delF.rows() << "×" << delF.cols() << " matrix:" << std::endl << delF; throw SolverError(err.str()); } } break; } case Formulation::small_strain: { cell.set_uniform_strain(Matrix_t::Zero(shape[0], shape[1])); - for (const auto &delF : load_steps) { - if (not((delF.rows() == shape[0]) and(delF.cols() == shape[1]))) { + for (const auto & delF : load_steps) { + if (not((delF.rows() == shape[0]) and (delF.cols() == shape[1]))) { std::stringstream err{}; err << "Load increments need to be given in " << shape[0] << "×" << shape[1] << " matrices, but I got a " << delF.rows() << "×" << delF.cols() << " matrix:" << std::endl << delF; throw SolverError(err.str()); } if (not check_symmetry(delF)) { throw SolverError("all Δε must be symmetric!"); } } break; } default: throw SolverError("Unknown strain measure"); break; } // initialise return value std::vector ret_val{}; // storage for the previous mean strain (to compute ΔF or Δε) Matrix_t previous_macro_strain{load_steps.back().Zero(shape[0], shape[1])}; auto F{cell.get_strain_vector()}; //! incremental loop - for (const auto ¯o_strain : load_steps) { + for (const auto & macro_strain : load_steps) { using StrainMap_t = RawFieldMap>; - for (auto &&strain : StrainMap_t(F, shape[0], shape[1])) { + for (auto && strain : StrainMap_t(F, shape[0], shape[1])) { strain += macro_strain - previous_macro_strain; } std::string message{"Has not converged"}; Real incr_norm{2 * newton_tol}, grad_norm{1}; Real stress_norm{2 * equil_tol}; bool has_converged{false}; auto convergence_test = [&incr_norm, &grad_norm, &newton_tol, &stress_norm, &equil_tol, &message, &has_converged]() { bool incr_test = incr_norm / grad_norm <= newton_tol; bool stress_test = stress_norm < equil_tol; if (incr_test) { message = "Residual tolerance reached"; } else if (stress_test) { message = "Reached stress divergence tolerance"; } has_converged = incr_test || stress_test; return has_converged; }; Uint newt_iter{0}; for (; newt_iter < solver.get_maxiter() && !has_converged; ++newt_iter) { // obtain material response auto res_tup{cell.evaluate_stress_tangent()}; - auto &P{std::get<0>(res_tup)}; + auto & P{std::get<0>(res_tup)}; rhs = -P; cell.apply_projection(rhs); stress_norm = std::sqrt(comm.sum(rhs.squaredNorm())); if (convergence_test()) { break; } //! this is a potentially avoidable copy TODO: check this out incrF = solver.solve(rhs); F += incrF; incr_norm = std::sqrt(comm.sum(incrF.squaredNorm())); grad_norm = std::sqrt(comm.sum(F.squaredNorm())); - if ((verbose > 0) and(comm.rank() == 0)) { + if ((verbose > 0) and (comm.rank() == 0)) { std::cout << "at Newton step " << std::setw(count_width) << newt_iter << ", |δ" << strain_symb << "|/|Δ" << strain_symb << "| = " << std::setw(17) << incr_norm / grad_norm << ", tol = " << newton_tol << std::endl; if (verbose - 1 > 1) { std::cout << "<" << strain_symb << "> =" << std::endl << StrainMap_t(F, shape[0], shape[1]).mean() << std::endl; } } convergence_test(); } // update previous macroscopic strain previous_macro_strain = macro_strain; // store results ret_val.emplace_back(OptimizeResult{ F, cell.get_stress_vector(), convergence_test(), Int(convergence_test()), message, newt_iter, solver.get_counter()}); // store history variables for next load increment cell.save_history_variables(); } return ret_val; } //----------------------------------------------------------------------------// - std::vector de_geus(Cell &cell, const LoadSteps_t &load_steps, - SolverBase &solver, Real newton_tol, + std::vector de_geus(Cell & cell, + const LoadSteps_t & load_steps, + SolverBase & solver, Real newton_tol, Real equil_tol, Dim_t verbose) { - const Communicator &comm = cell.get_communicator(); + const Communicator & comm = cell.get_communicator(); using Vector_t = Eigen::Matrix; using Matrix_t = Eigen::Matrix; // Corresponds to symbol δF or δε Vector_t incrF(cell.get_nb_dof()); // Corresponds to symbol ΔF or Δε Vector_t DeltaF(cell.get_nb_dof()); // field to store the rhs for cg calculations Vector_t rhs(cell.get_nb_dof()); solver.initialise(); size_t count_width{}; const auto form{cell.get_formulation()}; std::string strain_symb{}; if (verbose > 0 && comm.rank() == 0) { // setup of algorithm 5.2 in Nocedal, Numerical Optimization (p. 111) std::cout << "de Geus-" << solver.get_name() << " for "; switch (form) { case Formulation::small_strain: { strain_symb = "ε"; std::cout << "small"; break; } case Formulation::finite_strain: { strain_symb = "F"; std::cout << "finite"; break; } default: throw SolverError("unknown formulation"); break; } std::cout << " strain with" << std::endl << "newton_tol = " << newton_tol << ", cg_tol = " << solver.get_tol() << " maxiter = " << solver.get_maxiter() << " and Δ" << strain_symb << " =" << std::endl; - for (auto &&tup : akantu::enumerate(load_steps)) { - auto &&counter{std::get<0>(tup)}; - auto &&grad{std::get<1>(tup)}; + for (auto && tup : akantu::enumerate(load_steps)) { + auto && counter{std::get<0>(tup)}; + auto && grad{std::get<1>(tup)}; std::cout << "Step " << counter + 1 << ":" << std::endl << grad << std::endl; } count_width = size_t(std::log10(solver.get_maxiter())) + 1; } auto shape{cell.get_strain_shape()}; switch (form) { case Formulation::finite_strain: { cell.set_uniform_strain(Matrix_t::Identity(shape[0], shape[1])); - for (const auto &delF : load_steps) { + for (const auto & delF : load_steps) { auto rows = delF.rows(); auto cols = delF.cols(); - if (not((rows == shape[0]) and(cols == shape[1]))) { + if (not((rows == shape[0]) and (cols == shape[1]))) { std::stringstream err{}; err << "Load increments need to be given in " << shape[0] << "×" << shape[1] << " matrices, but I got a " << delF.rows() << "×" << delF.cols() << " matrix:" << std::endl << delF; throw SolverError(err.str()); } } break; } case Formulation::small_strain: { cell.set_uniform_strain(Matrix_t::Zero(shape[0], shape[1])); - for (const auto &delF : load_steps) { - if (not((delF.rows() == shape[0]) and(delF.cols() == shape[1]))) { + for (const auto & delF : load_steps) { + if (not((delF.rows() == shape[0]) and (delF.cols() == shape[1]))) { std::stringstream err{}; err << "Load increments need to be given in " << shape[0] << "×" << shape[1] << " matrices, but I got a " << delF.rows() << "×" << delF.cols() << " matrix:" << std::endl << delF; throw SolverError(err.str()); } if (not check_symmetry(delF)) { throw SolverError("all Δε must be symmetric!"); } } break; } default: throw SolverError("Unknown strain measure"); break; } // initialise return value std::vector ret_val{}; // storage for the previous mean strain (to compute ΔF or Δε) Matrix_t previous_macro_strain{load_steps.back().Zero(shape[0], shape[1])}; auto F{cell.get_strain_vector()}; //! incremental loop - for (const auto ¯o_strain : load_steps) { + for (const auto & macro_strain : load_steps) { using StrainMap_t = RawFieldMap>; std::string message{"Has not converged"}; Real incr_norm{2 * newton_tol}, grad_norm{1}; Real stress_norm{2 * equil_tol}; bool has_converged{false}; auto convergence_test = [&incr_norm, &grad_norm, &newton_tol, &stress_norm, &equil_tol, &message, &has_converged]() { bool incr_test = incr_norm / grad_norm <= newton_tol; bool stress_test = stress_norm < equil_tol; if (incr_test) { message = "Residual tolerance reached"; } else if (stress_test) { message = "Reached stress divergence tolerance"; } has_converged = incr_test || stress_test; return has_converged; }; Uint newt_iter{0}; for (; newt_iter < solver.get_maxiter() && !has_converged; ++newt_iter) { // obtain material response auto res_tup{cell.evaluate_stress_tangent()}; - auto &P{std::get<0>(res_tup)}; + auto & P{std::get<0>(res_tup)}; if (newt_iter == 0) { - for (auto &&strain : StrainMap_t(DeltaF, shape[0], shape[1])) { + for (auto && strain : StrainMap_t(DeltaF, shape[0], shape[1])) { strain = macro_strain - previous_macro_strain; } rhs = -cell.evaluate_projected_directional_stiffness(DeltaF); stress_norm = std::sqrt(comm.sum(rhs.matrix().squaredNorm())); if (convergence_test()) { break; } incrF = solver.solve(rhs); F += DeltaF; } else { rhs = -P; cell.apply_projection(rhs); stress_norm = std::sqrt(comm.sum(rhs.matrix().squaredNorm())); if (convergence_test()) { break; } incrF = solver.solve(rhs); } F += incrF; incr_norm = std::sqrt(comm.sum(incrF.squaredNorm())); grad_norm = std::sqrt(comm.sum(F.squaredNorm())); if ((verbose > 0) and // (comm.rank() == 0)) { std::cout << "at Newton step " << std::setw(count_width) << newt_iter << ", |δ" << strain_symb << "|/|Δ" << strain_symb << "| = " << std::setw(17) << incr_norm / grad_norm << ", tol = " << newton_tol << std::endl; if (verbose - 1 > 1) { std::cout << "<" << strain_symb << "> =" << std::endl << StrainMap_t(F, shape[0], shape[1]).mean() << std::endl; } } convergence_test(); } // update previous macroscopic strain previous_macro_strain = macro_strain; // store results ret_val.emplace_back(OptimizeResult{ F, cell.get_stress_vector(), convergence_test(), Int(convergence_test()), message, newt_iter, solver.get_counter()}); // store history variables for next load increment cell.save_history_variables(); } return ret_val; } } // namespace muSpectre diff --git a/src/solver/solvers.hh b/src/solver/solvers.hh index 90857c6..0e074f6 100644 --- a/src/solver/solvers.hh +++ b/src/solver/solvers.hh @@ -1,95 +1,96 @@ /** * file solvers.hh * * @author Till Junge * * @date 24 Apr 2018 * * @brief Free functions for solving rve problems * * Copyright © 2018 Till Junge * * µSpectre 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, 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 Lesser General Public License * along with µSpectre; see the file COPYING. If not, write to the * Free Software Foundation, Inc., 59 Temple Place - Suite 330, * * Boston, MA 02111-1307, USA. * * Additional permission under GNU GPL version 3 section 7 * * If you modify this Program, or any covered work, by linking or combining it * with proprietary FFT implementations or numerical libraries, containing parts * covered by the terms of those libraries' licenses, the licensors of this * Program grant you additional permission to convey the resulting work. */ #ifndef SRC_SOLVER_SOLVERS_HH_ #define SRC_SOLVER_SOLVERS_HH_ #include "solver/solver_base.hh" #include #include #include namespace muSpectre { using LoadSteps_t = std::vector; /** * Uses the Newton-conjugate Gradient method to find the static * equilibrium of a cell given a series of mean applied strains */ - std::vector newton_cg(Cell &cell, - const LoadSteps_t &load_steps, - SolverBase &solver, Real newton_tol, + std::vector newton_cg(Cell & cell, + const LoadSteps_t & load_steps, + SolverBase & solver, Real newton_tol, Real equil_tol, Dim_t verbose = 0); /** * Uses the Newton-conjugate Gradient method to find the static * equilibrium of a cell given a mean applied strain */ - OptimizeResult newton_cg(Cell &cell, + OptimizeResult newton_cg(Cell & cell, const Eigen::Ref load_step, - SolverBase &solver, Real newton_tol, Real equil_tol, + SolverBase & solver, Real newton_tol, Real equil_tol, Dim_t verbose = 0) { LoadSteps_t load_steps{load_step}; return newton_cg(cell, load_steps, solver, newton_tol, equil_tol, verbose) .front(); } /* ---------------------------------------------------------------------- */ /** * Uses the method proposed by de Geus method to find the static * equilibrium of a cell given a series of mean applied strains */ - std::vector de_geus(Cell &cell, const LoadSteps_t &load_steps, - SolverBase &solver, Real newton_tol, + std::vector de_geus(Cell & cell, + const LoadSteps_t & load_steps, + SolverBase & solver, Real newton_tol, Real equil_tol, Dim_t verbose = 0); /* ---------------------------------------------------------------------- */ /** * Uses the method proposed by de Geus method to find the static * equilibrium of a cell given a mean applied strain */ - OptimizeResult de_geus(Cell &cell, + OptimizeResult de_geus(Cell & cell, const Eigen::Ref load_step, - SolverBase &solver, Real newton_tol, Real equil_tol, + SolverBase & solver, Real newton_tol, Real equil_tol, Dim_t verbose = 0) { return de_geus(cell, LoadSteps_t{load_step}, solver, newton_tol, equil_tol, verbose)[0]; } } // namespace muSpectre #endif // SRC_SOLVER_SOLVERS_HH_ diff --git a/tests/header_test_field_collections.cc b/tests/header_test_field_collections.cc index d9c2004..db79fe2 100644 --- a/tests/header_test_field_collections.cc +++ b/tests/header_test_field_collections.cc @@ -1,707 +1,707 @@ /** * @file header_test_field_collections_1.cc * * @author Till Junge * * @date 20 Sep 2017 * * @brief Test the FieldCollection classes which provide fast optimized * iterators over run-time typed fields * * Copyright © 2017 Till Junge * * µSpectre 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, 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 Lesser General Public License * along with µSpectre; see the file COPYING. If not, write to the * Free Software Foundation, Inc., 59 Temple Place - Suite 330, * * Boston, MA 02111-1307, USA. * * Additional permission under GNU GPL version 3 section 7 * * If you modify this Program, or any covered work, by linking or combining it * with proprietary FFT implementations or numerical libraries, containing parts * covered by the terms of those libraries' licenses, the licensors of this * Program grant you additional permission to convey the resulting work. */ #include "test_field_collections.hh" #include "common/field_map_dynamic.hh" namespace muSpectre { BOOST_AUTO_TEST_SUITE(field_collection_tests); BOOST_AUTO_TEST_CASE(simple) { constexpr Dim_t sdim = 2; using FC_t = GlobalFieldCollection; FC_t fc; BOOST_CHECK_EQUAL(FC_t::spatial_dim(), sdim); BOOST_CHECK_EQUAL(fc.get_spatial_dim(), sdim); } BOOST_FIXTURE_TEST_CASE_TEMPLATE(Simple_construction_test, F, test_collections, F) { BOOST_CHECK_EQUAL(F::FC_t::spatial_dim(), F::sdim()); BOOST_CHECK_EQUAL(F::fc.get_spatial_dim(), F::sdim()); } BOOST_FIXTURE_TEST_CASE_TEMPLATE(get_field2_test, F, test_collections, F) { const auto order{2}; using FC_t = typename F::FC_t; using TF_t = TensorField; - auto &&myfield = make_field("TensorField real 2", F::fc); + auto && myfield = make_field("TensorField real 2", F::fc); using TensorMap = TensorFieldMap; using MatrixMap = MatrixFieldMap; using ArrayMap = ArrayFieldMap; TensorMap TFM(myfield); MatrixMap MFM(myfield); ArrayMap AFM(myfield); BOOST_CHECK_EQUAL(TFM.info_string(), "Tensor(d, " + std::to_string(order) + "_o, " + std::to_string(F::mdim()) + "_d)"); BOOST_CHECK_EQUAL(MFM.info_string(), "Matrix(d, " + std::to_string(F::mdim()) + "x" + std::to_string(F::mdim()) + ")"); BOOST_CHECK_EQUAL(AFM.info_string(), "Array(d, " + std::to_string(F::mdim()) + "x" + std::to_string(F::mdim()) + ")"); } BOOST_FIXTURE_TEST_CASE_TEMPLATE(multi_field_test, F, mult_collections, F) { using FC_t = typename F::FC_t; // possible maptypes for Real tensor fields using T_type = Real; using T_TFM1_t = TensorFieldMap; using T_TFM2_t = TensorFieldMap; //! dangerous using T4_Map_t = T4MatrixFieldMap; // impossible maptypes for Real tensor fields using T_SFM_t = ScalarFieldMap; using T_MFM_t = MatrixFieldMap; using T_AFM_t = ArrayFieldMap; using T_MFMw1_t = MatrixFieldMap; using T_MFMw2_t = MatrixFieldMap; using T_MFMw3_t = MatrixFieldMap; const std::string T_name{"Tensorfield Real o4"}; const std::string T_name_w{"TensorField Real o4 wrongname"}; BOOST_CHECK_THROW(T_SFM_t(F::fc.at(T_name)), FieldInterpretationError); BOOST_CHECK_NO_THROW(T_TFM1_t(F::fc.at(T_name))); BOOST_CHECK_NO_THROW(T_TFM2_t(F::fc.at(T_name))); BOOST_CHECK_NO_THROW(T4_Map_t(F::fc.at(T_name))); BOOST_CHECK_THROW(T4_Map_t(F::fc.at(T_name_w)), std::out_of_range); BOOST_CHECK_THROW(T_MFM_t(F::fc.at(T_name)), FieldInterpretationError); BOOST_CHECK_THROW(T_AFM_t(F::fc.at(T_name)), FieldInterpretationError); BOOST_CHECK_THROW(T_MFMw1_t(F::fc.at(T_name)), FieldInterpretationError); BOOST_CHECK_THROW(T_MFMw2_t(F::fc.at(T_name)), FieldInterpretationError); BOOST_CHECK_THROW(T_MFMw2_t(F::fc.at(T_name)), FieldInterpretationError); BOOST_CHECK_THROW(T_MFMw3_t(F::fc.at(T_name)), FieldInterpretationError); BOOST_CHECK_THROW(T_SFM_t(F::fc.at(T_name_w)), std::out_of_range); // possible maptypes for integer scalar fields using S_type = Int; using S_SFM_t = ScalarFieldMap; using S_TFM1_t = TensorFieldMap; using S_TFM2_t = TensorFieldMap; using S_MFM_t = MatrixFieldMap; using S_AFM_t = ArrayFieldMap; using S4_Map_t = T4MatrixFieldMap; // impossible maptypes for integer scalar fields using S_MFMw1_t = MatrixFieldMap; using S_MFMw2_t = MatrixFieldMap; using S_MFMw3_t = MatrixFieldMap; const std::string S_name{"integer Scalar"}; const std::string S_name_w{"integer Scalar wrongname"}; BOOST_CHECK_NO_THROW(S_SFM_t(F::fc.at(S_name))); BOOST_CHECK_NO_THROW(S_TFM1_t(F::fc.at(S_name))); BOOST_CHECK_NO_THROW(S_TFM2_t(F::fc.at(S_name))); BOOST_CHECK_NO_THROW(S_MFM_t(F::fc.at(S_name))); BOOST_CHECK_NO_THROW(S_AFM_t(F::fc.at(S_name))); BOOST_CHECK_NO_THROW(S4_Map_t(F::fc.at(S_name))); BOOST_CHECK_THROW(S_MFMw1_t(F::fc.at(S_name)), FieldInterpretationError); BOOST_CHECK_THROW(T4_Map_t(F::fc.at(S_name)), FieldInterpretationError); BOOST_CHECK_THROW(S_MFMw2_t(F::fc.at(S_name)), FieldInterpretationError); BOOST_CHECK_THROW(S_MFMw2_t(F::fc.at(S_name)), FieldInterpretationError); BOOST_CHECK_THROW(S_MFMw3_t(F::fc.at(S_name)), FieldInterpretationError); BOOST_CHECK_THROW(S_SFM_t(F::fc.at(S_name_w)), std::out_of_range); // possible maptypes for complex matrix fields using M_type = Complex; using M_MFM_t = MatrixFieldMap; using M_AFM_t = ArrayFieldMap; // impossible maptypes for complex matrix fields using M_SFM_t = ScalarFieldMap; using M_MFMw1_t = MatrixFieldMap; using M_MFMw2_t = MatrixFieldMap; using M_MFMw3_t = MatrixFieldMap; const std::string M_name{"Matrixfield Complex sdim x mdim"}; const std::string M_name_w{"Matrixfield Complex sdim x mdim wrongname"}; BOOST_CHECK_THROW(M_SFM_t(F::fc.at(M_name)), FieldInterpretationError); BOOST_CHECK_NO_THROW(M_MFM_t(F::fc.at(M_name))); BOOST_CHECK_NO_THROW(M_AFM_t(F::fc.at(M_name))); BOOST_CHECK_THROW(M_MFMw1_t(F::fc.at(M_name)), FieldInterpretationError); BOOST_CHECK_THROW(M_MFMw2_t(F::fc.at(M_name)), FieldInterpretationError); BOOST_CHECK_THROW(M_MFMw2_t(F::fc.at(M_name)), FieldInterpretationError); BOOST_CHECK_THROW(M_MFMw3_t(F::fc.at(M_name)), FieldInterpretationError); BOOST_CHECK_THROW(M_SFM_t(F::fc.at(M_name_w)), std::out_of_range); } /* ---------------------------------------------------------------------- */ //! Check whether fields can be initialized using mult_collections_t = boost::mpl::list, FC_multi_fixture<2, 3, true>, FC_multi_fixture<3, 3, true>>; using mult_collections_f = boost::mpl::list, FC_multi_fixture<2, 3, false>, FC_multi_fixture<3, 3, false>>; BOOST_FIXTURE_TEST_CASE_TEMPLATE(init_test_glob, F, mult_collections_t, F) { Ccoord_t size; Ccoord_t loc{}; - for (auto &&s : size) { + for (auto && s : size) { s = 3; } BOOST_CHECK_NO_THROW(F::fc.initialise(size, loc)); } BOOST_FIXTURE_TEST_CASE_TEMPLATE(init_test_loca, F, mult_collections_f, F) { testGoodies::RandRange rng; for (int i = 0; i < 7; ++i) { Ccoord_t pixel; - for (auto &&s : pixel) { + for (auto && s : pixel) { s = rng.randval(0, 7); } F::fc.add_pixel(pixel); } BOOST_CHECK_NO_THROW(F::fc.initialise()); } BOOST_FIXTURE_TEST_CASE_TEMPLATE(init_test_loca_with_push_back, F, mult_collections_f, F) { constexpr auto mdim{F::mdim()}; constexpr int nb_pix{7}; testGoodies::RandRange rng{}; using ftype = internal::TypedSizedFieldBase; using stype = Eigen::Array; - auto &field = static_cast(F::fc["Tensorfield Real o4"]); + auto & field = static_cast(F::fc["Tensorfield Real o4"]); field.push_back(stype()); for (int i = 0; i < nb_pix; ++i) { Ccoord_t pixel; - for (auto &&s : pixel) { + for (auto && s : pixel) { s = rng.randval(0, 7); } F::fc.add_pixel(pixel); } BOOST_CHECK_THROW(F::fc.initialise(), FieldCollectionError); for (int i = 0; i < nb_pix - 1; ++i) { field.push_back(stype()); } BOOST_CHECK_NO_THROW(F::fc.initialise()); } BOOST_FIXTURE_TEST_CASE_TEMPLATE(iter_field_test, F, iter_collections, F) { using FC_t = typename F::Parent::FC_t; using Tensor4Map = TensorFieldMap; Tensor4Map T4map{F::fc["Tensorfield Real o4"]}; TypedFieldMap dyn_map{F::fc["Tensorfield Real o4"]}; F::fc["Tensorfield Real o4"].set_zero(); - for (auto &&tens : T4map) { + for (auto && tens : T4map) { BOOST_CHECK_EQUAL(Real(Eigen::Tensor(tens.abs().sum().eval())()), 0); } - for (auto &&tens : T4map) { + for (auto && tens : T4map) { tens.setRandom(); } - for (auto &&tup : akantu::zip(T4map, dyn_map)) { - auto &tens = std::get<0>(tup); - auto &dyn = std::get<1>(tup); + for (auto && tup : akantu::zip(T4map, dyn_map)) { + auto & tens = std::get<0>(tup); + auto & dyn = std::get<1>(tup); constexpr Dim_t nb_comp{ipow(F::mdim(), order)}; Eigen::Map> tens_arr(tens.data()); Real error{(dyn - tens_arr).matrix().norm()}; BOOST_CHECK_EQUAL(error, 0); } using Tensor2Map = TensorFieldMap; using MSqMap = MatrixFieldMap; using ASqMap = ArrayFieldMap; using A2Map = ArrayFieldMap; using WrongMap = ArrayFieldMap; Tensor2Map T2map{F::fc["Tensorfield Real o2"]}; MSqMap Mmap{F::fc["Tensorfield Real o2"]}; ASqMap Amap{F::fc["Tensorfield Real o2"]}; A2Map DynMap{F::fc["Dynamically sized Field"]}; - auto &fc_ref{F::fc}; + auto & fc_ref{F::fc}; BOOST_CHECK_THROW(WrongMap{fc_ref["Dynamically sized Field"]}, FieldInterpretationError); auto t2_it = T2map.begin(); auto t2_it_end = T2map.end(); auto m_it = Mmap.begin(); auto a_it = Amap.begin(); for (; t2_it != t2_it_end; ++t2_it, ++m_it, ++a_it) { t2_it->setRandom(); - auto &&m = *m_it; + auto && m = *m_it; bool comp = (m == a_it->matrix()); BOOST_CHECK(comp); } size_t counter{0}; for (auto val : DynMap) { ++counter; val += val.Ones() * counter; } counter = 0; for (auto val : DynMap) { ++counter; val -= val.Ones() * counter; auto error{val.matrix().norm()}; BOOST_CHECK_LT(error, tol); } using ScalarMap = ScalarFieldMap; ScalarMap s_map{F::fc["integer Scalar"]}; for (Uint i = 0; i < s_map.size(); ++i) { s_map[i] = i; } counter = 0; - for (const auto &val : s_map) { + for (const auto & val : s_map) { BOOST_CHECK_EQUAL(counter++, val); } } BOOST_FIXTURE_TEST_CASE_TEMPLATE(ccoord_indexing_test, F, glob_iter_colls, F) { using FC_t = typename F::Parent::FC_t; using ScalarMap = ScalarFieldMap; ScalarMap s_map{F::fc["integer Scalar"]}; for (Uint i = 0; i < s_map.size(); ++i) { s_map[i] = i; } for (size_t i = 0; i < CcoordOps::get_size(F::fc.get_sizes()); ++i) { BOOST_CHECK_EQUAL( CcoordOps::get_index(F::fc.get_sizes(), F::fc.get_locations(), CcoordOps::get_ccoord(F::fc.get_sizes(), F::fc.get_locations(), i)), i); } } BOOST_FIXTURE_TEST_CASE_TEMPLATE(iterator_methods_test, F, iter_collections, F) { using FC_t = typename F::Parent::FC_t; using Tensor4Map = TensorFieldMap; Tensor4Map T4map{F::fc["Tensorfield Real o4"]}; using it_t = typename Tensor4Map::iterator; std::ptrdiff_t diff{ 3}; // arbitrary, as long as it is smaller than the container size // check constructors auto itstart = T4map.begin(); // standard way of obtaining iterator auto itend = T4map.end(); // ditto it_t it1{T4map}; it_t it2{T4map, false}; it_t it3{T4map, size_t(diff)}; BOOST_CHECK(itstart == itstart); BOOST_CHECK(itstart != itend); BOOST_CHECK_EQUAL(itstart, it1); BOOST_CHECK_EQUAL(itend, it2); // check ostream operator std::stringstream response; response << it3; BOOST_CHECK_EQUAL( response.str(), std::string("iterator on field 'Tensorfield Real o4', entry ") + std::to_string(diff)); // check move and assigment constructor (and operator+) it_t it_repl{T4map}; it_t itmove = std::move(T4map.begin()); it_t it4 = it1 + diff; it_t it7 = it4 - diff; // BOOST_CHECK_EQUAL(itcopy, it1); BOOST_CHECK_EQUAL(itmove, it1); BOOST_CHECK_EQUAL(it4, it3); BOOST_CHECK_EQUAL(it7, it1); // check increments/decrements BOOST_CHECK_EQUAL(it1++, it_repl); // post-increment BOOST_CHECK_EQUAL(it1, it_repl + 1); BOOST_CHECK_EQUAL(--it1, it_repl); // pre -decrement BOOST_CHECK_EQUAL(++it1, it_repl + 1); // pre -increment BOOST_CHECK_EQUAL(it1--, it_repl + 1); // post-decrement BOOST_CHECK_EQUAL(it1, it_repl); // dereference and member-of-pointer check Eigen::Tensor Tens = *it1; Eigen::Tensor Tens2 = *itstart; Eigen::Tensor check = (Tens == Tens2).all(); BOOST_CHECK_EQUAL(static_cast(check()), true); BOOST_CHECK_NO_THROW(itstart->setZero()); // check access subscripting auto T3a = *it3; auto T3b = itstart[diff]; - BOOST_CHECK(static_cast - (Eigen::Tensor((T3a == T3b).all())())); + BOOST_CHECK( + static_cast(Eigen::Tensor((T3a == T3b).all())())); // div. comparisons BOOST_CHECK_LT(itstart, itend); BOOST_CHECK(!(itend < itstart)); BOOST_CHECK(!(itstart < itstart)); BOOST_CHECK_LE(itstart, itend); BOOST_CHECK_LE(itstart, itstart); BOOST_CHECK(!(itend <= itstart)); BOOST_CHECK_GT(itend, itstart); BOOST_CHECK(!(itend > itend)); BOOST_CHECK(!(itstart > itend)); BOOST_CHECK_GE(itend, itstart); BOOST_CHECK_GE(itend, itend); BOOST_CHECK(!(itstart >= itend)); // check assignment increment/decrement BOOST_CHECK_EQUAL(it1 += diff, it3); BOOST_CHECK_EQUAL(it1 -= diff, itstart); // check cell coordinates using Ccoord = Ccoord_t; Ccoord a{itstart.get_ccoord()}; Ccoord b{0}; // Weirdly, boost::has_left_shift::value is false for // Ccoords, even though the operator is implemented :( // BOOST_CHECK_EQUAL(a, b); bool check2 = (a == b); BOOST_CHECK(check2); } BOOST_FIXTURE_TEST_CASE_TEMPLATE(const_tensor_iter_test, F, iter_collections, F) { using FC_t = typename F::Parent::FC_t; using Tensor4Map = TensorFieldMap; Tensor4Map T4map{F::fc["Tensorfield Real o4"]}; using T_t = typename Tensor4Map::T_t; Eigen::TensorMap Tens2(T4map[0].data(), F::Parent::sdim(), F::Parent::sdim(), F::Parent::sdim(), F::Parent::sdim()); for (auto it = T4map.cbegin(); it != T4map.cend(); ++it) { // maps to const tensors can't be initialised with a const pointer this // sucks - auto &&tens = *it; - auto &&ptr = tens.data(); + auto && tens = *it; + auto && ptr = tens.data(); static_assert( std::is_pointer>::value, "should be getting a pointer"); // static_assert(std::is_const>::value, // "should be const"); // If Tensor were written well, above static_assert should pass, and the // following check shouldn't. If it get triggered, it means that a newer // version of Eigen now does have const-correct // TensorMap. This means that const-correct field maps // are then also possible for tensors BOOST_CHECK(!std::is_const>::value); } } BOOST_FIXTURE_TEST_CASE_TEMPLATE(const_matrix_iter_test, F, iter_collections, F) { using FC_t = typename F::Parent::FC_t; using MatrixMap = MatrixFieldMap; MatrixMap Mmap{F::fc["Matrixfield Complex sdim x mdim"]}; for (auto it = Mmap.cbegin(); it != Mmap.cend(); ++it) { // maps to const tensors can't be initialised with a const pointer this // sucks - auto &&mat = *it; - auto &&ptr = mat.data(); + auto && mat = *it; + auto && ptr = mat.data(); static_assert( std::is_pointer>::value, "should be getting a pointer"); // static_assert(std::is_const>::value, // "should be const"); // If Matrix were written well, above static_assert should pass, and the // following check shouldn't. If it get triggered, it means that a newer // version of Eigen now does have const-correct // MatrixMap. This means that const-correct field maps // are then also possible for matrices BOOST_CHECK(!std::is_const>::value); } } BOOST_FIXTURE_TEST_CASE_TEMPLATE(const_scalar_iter_test, F, iter_collections, F) { using FC_t = typename F::Parent::FC_t; using ScalarMap = ScalarFieldMap; ScalarMap Smap{F::fc["integer Scalar"]}; for (auto it = Smap.cbegin(); it != Smap.cend(); ++it) { - auto &&scal = *it; + auto && scal = *it; static_assert( std::is_const>::value, "referred type should be const"); static_assert(std::is_lvalue_reference::value, "Should have returned an lvalue ref"); } } /* ---------------------------------------------------------------------- */ BOOST_FIXTURE_TEST_CASE_TEMPLATE(assignment_test, Fix, iter_collections, Fix) { auto t4map{Fix::t4_field.get_map()}; auto t2map{Fix::t2_field.get_map()}; auto scmap{Fix::sc_field.get_map()}; auto m2map{Fix::m2_field.get_map()}; auto dymap{Fix::dyn_field.get_map()}; auto t4map_c{Fix::t4_field.get_const_map()}; auto t2map_c{Fix::t2_field.get_const_map()}; auto scmap_c{Fix::sc_field.get_const_map()}; auto m2map_c{Fix::m2_field.get_const_map()}; auto dymap_c{Fix::dyn_field.get_const_map()}; const auto t4map_val{Matrices::Isymm()}; t4map = t4map_val; const auto t2map_val{Matrices::I2()}; t2map = t2map_val; const Int scmap_val{1}; scmap = scmap_val; Eigen::Matrix m2map_val; m2map_val.setRandom(); m2map = m2map_val; const size_t nb_pts{Fix::fc.size()}; testGoodies::RandRange rnd{}; BOOST_CHECK_EQUAL((t4map[rnd.randval(0, nb_pts - 1)] - t4map_val).norm(), 0.); BOOST_CHECK_EQUAL((t2map[rnd.randval(0, nb_pts - 1)] - t2map_val).norm(), 0.); BOOST_CHECK_EQUAL((scmap[rnd.randval(0, nb_pts - 1)] - scmap_val), 0.); BOOST_CHECK_EQUAL((m2map[rnd.randval(0, nb_pts - 1)] - m2map_val).norm(), 0.); } /* ---------------------------------------------------------------------- */ BOOST_FIXTURE_TEST_CASE_TEMPLATE(Eigentest, Fix, iter_collections, Fix) { auto t4eigen = Fix::t4_field.eigen(); auto t2eigen = Fix::t2_field.eigen(); BOOST_CHECK_EQUAL(t4eigen.rows(), ipow(Fix::mdim(), 4)); BOOST_CHECK_EQUAL(t4eigen.cols(), Fix::t4_field.size()); using T2_t = typename Eigen::Matrix; T2_t test_mat; test_mat.setRandom(); Eigen::Map> test_map( test_mat.data()); t2eigen.col(0) = test_map; BOOST_CHECK_EQUAL((Fix::t2_field.get_map()[0] - test_mat).norm(), 0.); } /* ---------------------------------------------------------------------- */ BOOST_FIXTURE_TEST_CASE_TEMPLATE(field_proxy_test, Fix, iter_collections, Fix) { Eigen::VectorXd t4values{Fix::t4_field.eigenvec()}; using FieldProxy_t = TypedField; //! create a field proxy FieldProxy_t proxy("proxy to 'Tensorfield Real o4'", Fix::fc, t4values, Fix::t4_field.get_nb_components()); Eigen::VectorXd wrong_size_not_multiple{ Eigen::VectorXd::Zero(t4values.size() + 1)}; BOOST_CHECK_THROW(FieldProxy_t("size not a multiple of nb_components", Fix::fc, wrong_size_not_multiple, Fix::t4_field.get_nb_components()), FieldError); Eigen::VectorXd wrong_size_but_multiple{Eigen::VectorXd::Zero( t4values.size() + Fix::t4_field.get_nb_components())}; BOOST_CHECK_THROW(FieldProxy_t("size wrong multiple of nb_components", Fix::fc, wrong_size_but_multiple, Fix::t4_field.get_nb_components()), FieldError); using Tensor4Map = T4MatrixFieldMap; Tensor4Map ref_map{Fix::t4_field}; Tensor4Map proxy_map{proxy}; for (auto tup : akantu::zip(ref_map, proxy_map)) { - auto &ref = std::get<0>(tup); - auto &prox = std::get<1>(tup); + auto & ref = std::get<0>(tup); + auto & prox = std::get<1>(tup); BOOST_CHECK_EQUAL((ref - prox).norm(), 0); } } /* ---------------------------------------------------------------------- */ BOOST_FIXTURE_TEST_CASE_TEMPLATE(field_proxy_of_existing_field, Fix, iter_collections, Fix) { Eigen::Ref t4values{Fix::t4_field.eigenvec()}; using FieldProxy_t = TypedField; //! create a field proxy FieldProxy_t proxy("proxy to 'Tensorfield Real o4'", Fix::fc, t4values, Fix::t4_field.get_nb_components()); using Tensor4Map = T4MatrixFieldMap; Tensor4Map ref_map{Fix::t4_field}; Tensor4Map proxy_map{proxy}; for (auto tup : akantu::zip(ref_map, proxy_map)) { - auto &ref = std::get<0>(tup); - auto &prox = std::get<1>(tup); + auto & ref = std::get<0>(tup); + auto & prox = std::get<1>(tup); prox += prox.Identity(); BOOST_CHECK_EQUAL((ref - prox).norm(), 0); } } /* ---------------------------------------------------------------------- */ BOOST_FIXTURE_TEST_CASE_TEMPLATE(typed_field_getter, Fix, mult_collections, Fix) { constexpr auto mdim{Fix::mdim()}; - auto &fc{Fix::fc}; - auto &field = fc.template get_typed_field("Tensorfield Real o4"); + auto & fc{Fix::fc}; + auto & field = fc.template get_typed_field("Tensorfield Real o4"); BOOST_CHECK_EQUAL(field.get_nb_components(), ipow(mdim, fourthOrder)); } /* ---------------------------------------------------------------------- */ BOOST_FIXTURE_TEST_CASE_TEMPLATE(enumeration, Fix, iter_collections, Fix) { auto t4map{Fix::t4_field.get_map()}; auto t2map{Fix::t2_field.get_map()}; auto scmap{Fix::sc_field.get_map()}; auto m2map{Fix::m2_field.get_map()}; auto dymap{Fix::dyn_field.get_map()}; - for (auto &&tup : + for (auto && tup : akantu::zip(scmap.get_collection(), scmap, scmap.enumerate())) { - const auto &ccoord_ref = std::get<0>(tup); - const auto &val_ref = std::get<1>(tup); - const auto &key_val = std::get<2>(tup); - const auto &ccoord = std::get<0>(key_val); - const auto &val = std::get<1>(key_val); - - for (auto &&ccoords : akantu::zip(ccoord_ref, ccoord)) { - const auto &ref{std::get<0>(ccoords)}; - const auto &val{std::get<1>(ccoords)}; + const auto & ccoord_ref = std::get<0>(tup); + const auto & val_ref = std::get<1>(tup); + const auto & key_val = std::get<2>(tup); + const auto & ccoord = std::get<0>(key_val); + const auto & val = std::get<1>(key_val); + + for (auto && ccoords : akantu::zip(ccoord_ref, ccoord)) { + const auto & ref{std::get<0>(ccoords)}; + const auto & val{std::get<1>(ccoords)}; BOOST_CHECK_EQUAL(ref, val); } const auto error{std::abs(val - val_ref)}; BOOST_CHECK_EQUAL(error, 0); } - for (auto &&tup : + for (auto && tup : akantu::zip(t4map.get_collection(), t4map, t4map.enumerate())) { - const auto &ccoord_ref = std::get<0>(tup); - const auto &val_ref = std::get<1>(tup); - const auto &key_val = std::get<2>(tup); - const auto &ccoord = std::get<0>(key_val); - const auto &val = std::get<1>(key_val); - - for (auto &&ccoords : akantu::zip(ccoord_ref, ccoord)) { - const auto &ref{std::get<0>(ccoords)}; - const auto &val{std::get<1>(ccoords)}; + const auto & ccoord_ref = std::get<0>(tup); + const auto & val_ref = std::get<1>(tup); + const auto & key_val = std::get<2>(tup); + const auto & ccoord = std::get<0>(key_val); + const auto & val = std::get<1>(key_val); + + for (auto && ccoords : akantu::zip(ccoord_ref, ccoord)) { + const auto & ref{std::get<0>(ccoords)}; + const auto & val{std::get<1>(ccoords)}; BOOST_CHECK_EQUAL(ref, val); } const auto error{(val - val_ref).norm()}; BOOST_CHECK_EQUAL(error, 0); } - for (auto &&tup : + for (auto && tup : akantu::zip(t2map.get_collection(), t2map, t2map.enumerate())) { - const auto &ccoord_ref = std::get<0>(tup); - const auto &val_ref = std::get<1>(tup); - const auto &key_val = std::get<2>(tup); - const auto &ccoord = std::get<0>(key_val); - const auto &val = std::get<1>(key_val); - - for (auto &&ccoords : akantu::zip(ccoord_ref, ccoord)) { - const auto &ref{std::get<0>(ccoords)}; - const auto &val{std::get<1>(ccoords)}; + const auto & ccoord_ref = std::get<0>(tup); + const auto & val_ref = std::get<1>(tup); + const auto & key_val = std::get<2>(tup); + const auto & ccoord = std::get<0>(key_val); + const auto & val = std::get<1>(key_val); + + for (auto && ccoords : akantu::zip(ccoord_ref, ccoord)) { + const auto & ref{std::get<0>(ccoords)}; + const auto & val{std::get<1>(ccoords)}; BOOST_CHECK_EQUAL(ref, val); } const auto error{(val - val_ref).norm()}; BOOST_CHECK_EQUAL(error, 0); } - for (auto &&tup : + for (auto && tup : akantu::zip(m2map.get_collection(), m2map, m2map.enumerate())) { - const auto &ccoord_ref = std::get<0>(tup); - const auto &val_ref = std::get<1>(tup); - const auto &key_val = std::get<2>(tup); - const auto &ccoord = std::get<0>(key_val); - const auto &val = std::get<1>(key_val); - - for (auto &&ccoords : akantu::zip(ccoord_ref, ccoord)) { - const auto &ref{std::get<0>(ccoords)}; - const auto &val{std::get<1>(ccoords)}; + const auto & ccoord_ref = std::get<0>(tup); + const auto & val_ref = std::get<1>(tup); + const auto & key_val = std::get<2>(tup); + const auto & ccoord = std::get<0>(key_val); + const auto & val = std::get<1>(key_val); + + for (auto && ccoords : akantu::zip(ccoord_ref, ccoord)) { + const auto & ref{std::get<0>(ccoords)}; + const auto & val{std::get<1>(ccoords)}; BOOST_CHECK_EQUAL(ref, val); } const auto error{(val - val_ref).norm()}; BOOST_CHECK_EQUAL(error, 0); } - for (auto &&tup : + for (auto && tup : akantu::zip(dymap.get_collection(), dymap, dymap.enumerate())) { - const auto &ccoord_ref = std::get<0>(tup); - const auto &val_ref = std::get<1>(tup); - const auto &key_val = std::get<2>(tup); - const auto &ccoord = std::get<0>(key_val); - const auto &val = std::get<1>(key_val); - - for (auto &&ccoords : akantu::zip(ccoord_ref, ccoord)) { - const auto &ref{std::get<0>(ccoords)}; - const auto &val{std::get<1>(ccoords)}; + const auto & ccoord_ref = std::get<0>(tup); + const auto & val_ref = std::get<1>(tup); + const auto & key_val = std::get<2>(tup); + const auto & ccoord = std::get<0>(key_val); + const auto & val = std::get<1>(key_val); + + for (auto && ccoords : akantu::zip(ccoord_ref, ccoord)) { + const auto & ref{std::get<0>(ccoords)}; + const auto & val{std::get<1>(ccoords)}; BOOST_CHECK_EQUAL(ref, val); } const auto error{(val - val_ref).matrix().norm()}; BOOST_CHECK_EQUAL(error, 0); } } BOOST_AUTO_TEST_SUITE_END(); } // namespace muSpectre diff --git a/tests/header_test_fields.cc b/tests/header_test_fields.cc index 1193fad..509be20 100644 --- a/tests/header_test_fields.cc +++ b/tests/header_test_fields.cc @@ -1,272 +1,273 @@ /** * @file header_test_fields.cc * * @author Till Junge * * @date 20 Sep 2017 * * @brief Test Fields that are used in FieldCollections * * Copyright © 2017 Till Junge * * µSpectre 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, 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 Lesser General Public License * along with µSpectre; see the file COPYING. If not, write to the * Free Software Foundation, Inc., 59 Temple Place - Suite 330, * * Boston, MA 02111-1307, USA. * * Additional permission under GNU GPL version 3 section 7 * * If you modify this Program, or any covered work, by linking or combining it * with proprietary FFT implementations or numerical libraries, containing parts * covered by the terms of those libraries' licenses, the licensors of this * Program grant you additional permission to convey the resulting work. */ #include "tests.hh" #include "common/field_collection.hh" #include "common/field.hh" #include "common/ccoord_operations.hh" #include #include namespace muSpectre { BOOST_AUTO_TEST_SUITE(field_test); - template struct FieldFixture { + template + struct FieldFixture { constexpr static bool IsGlobal{Global}; constexpr static Dim_t Order{secondOrder}; constexpr static Dim_t SDim{twoD}; constexpr static Dim_t MDim{threeD}; constexpr static Dim_t NbComponents{ipow(MDim, Order)}; using FieldColl_t = std::conditional_t, LocalFieldCollection>; using TField_t = TensorField; using MField_t = MatrixField; using DField_t = TypedField; FieldFixture() : tensor_field{make_field("TensorField", this->fc)}, matrix_field{make_field("MatrixField", this->fc)}, dynamic_field1{make_field( "Dynamically sized field with correct number of" " components", this->fc, ipow(MDim, Order))}, dynamic_field2{make_field( "Dynamically sized field with incorrect number" " of components", this->fc, NbComponents + 1)} {} ~FieldFixture() = default; FieldColl_t fc{}; - TField_t &tensor_field; - MField_t &matrix_field; - DField_t &dynamic_field1; - DField_t &dynamic_field2; + TField_t & tensor_field; + MField_t & matrix_field; + DField_t & dynamic_field1; + DField_t & dynamic_field2; }; using field_fixtures = boost::mpl::list, FieldFixture>; /* ---------------------------------------------------------------------- */ BOOST_FIXTURE_TEST_CASE(size_check_global, FieldFixture) { // check that fields are initialised with empty vector BOOST_CHECK_EQUAL(tensor_field.size(), 0); BOOST_CHECK_EQUAL(dynamic_field1.size(), 0); BOOST_CHECK_EQUAL(dynamic_field2.size(), 0); // check that returned size is correct Dim_t len{2}; auto sizes{CcoordOps::get_cube(len)}; fc.initialise(sizes, {}); auto nb_pixels{CcoordOps::get_size(sizes)}; BOOST_CHECK_EQUAL(tensor_field.size(), nb_pixels); BOOST_CHECK_EQUAL(dynamic_field1.size(), nb_pixels); BOOST_CHECK_EQUAL(dynamic_field2.size(), nb_pixels); constexpr Dim_t pad_size{3}; tensor_field.set_pad_size(pad_size); dynamic_field1.set_pad_size(pad_size); dynamic_field2.set_pad_size(pad_size); // check that setting pad size won't change logical size BOOST_CHECK_EQUAL(tensor_field.size(), nb_pixels); BOOST_CHECK_EQUAL(dynamic_field1.size(), nb_pixels); BOOST_CHECK_EQUAL(dynamic_field2.size(), nb_pixels); } /* ---------------------------------------------------------------------- */ BOOST_FIXTURE_TEST_CASE(size_check_local, FieldFixture) { // check that fields are initialised with empty vector BOOST_CHECK_EQUAL(tensor_field.size(), 0); BOOST_CHECK_EQUAL(dynamic_field1.size(), 0); BOOST_CHECK_EQUAL(dynamic_field2.size(), 0); // check that returned size is correct Dim_t nb_pixels{3}; Eigen::Array new_elem; Eigen::Array wrong_elem; for (Dim_t i{0}; i < NbComponents; ++i) { new_elem(i) = i; wrong_elem(i) = .1 * i; } for (Dim_t i{0}; i < nb_pixels; ++i) { tensor_field.push_back(new_elem); dynamic_field1.push_back(new_elem); BOOST_CHECK_THROW(dynamic_field1.push_back(wrong_elem), FieldError); BOOST_CHECK_THROW(dynamic_field2.push_back(new_elem), FieldError); } BOOST_CHECK_EQUAL(tensor_field.size(), nb_pixels); BOOST_CHECK_EQUAL(dynamic_field1.size(), nb_pixels); BOOST_CHECK_EQUAL(dynamic_field2.size(), 0); for (Dim_t i{0}; i < nb_pixels; ++i) { fc.add_pixel({i}); } fc.initialise(); BOOST_CHECK_EQUAL(tensor_field.size(), nb_pixels); BOOST_CHECK_EQUAL(dynamic_field1.size(), nb_pixels); BOOST_CHECK_EQUAL(dynamic_field2.size(), nb_pixels); BOOST_CHECK_EQUAL(tensor_field.get_pad_size(), 0); BOOST_CHECK_EQUAL(dynamic_field1.get_pad_size(), 0); BOOST_CHECK_EQUAL(dynamic_field2.get_pad_size(), 0); constexpr Dim_t pad_size{3}; tensor_field.set_pad_size(pad_size); dynamic_field1.set_pad_size(pad_size); dynamic_field2.set_pad_size(pad_size); BOOST_CHECK_EQUAL(tensor_field.get_pad_size(), pad_size); BOOST_CHECK_EQUAL(dynamic_field1.get_pad_size(), pad_size); BOOST_CHECK_EQUAL(dynamic_field2.get_pad_size(), pad_size); // check that setting pad size won't change logical size BOOST_CHECK_EQUAL(tensor_field.size(), nb_pixels); BOOST_CHECK_EQUAL(dynamic_field1.size(), nb_pixels); BOOST_CHECK_EQUAL(dynamic_field2.size(), nb_pixels); } BOOST_AUTO_TEST_CASE(simple_creation) { constexpr Dim_t sdim{twoD}; constexpr Dim_t mdim{twoD}; constexpr Dim_t order{fourthOrder}; using FC_t = GlobalFieldCollection; FC_t fc; using TF_t = TensorField; - auto &field{make_field("TensorField 1", fc)}; + auto & field{make_field("TensorField 1", fc)}; // check that fields are initialised with empty vector BOOST_CHECK_EQUAL(field.size(), 0); Dim_t len{2}; fc.initialise(CcoordOps::get_cube(len), {}); // check that returned size is correct BOOST_CHECK_EQUAL(field.size(), ipow(len, sdim)); // check that setting pad size won't change logical size field.set_pad_size(24); BOOST_CHECK_EQUAL(field.size(), ipow(len, sdim)); } BOOST_AUTO_TEST_CASE(dynamic_field_creation) { constexpr Dim_t sdim{threeD}; Dim_t nb_components{2}; using FC_t = GlobalFieldCollection; FC_t fc{}; make_field>("Dynamic Field", fc, nb_components); } BOOST_FIXTURE_TEST_CASE_TEMPLATE(get_zeros_like, Fix, field_fixtures, Fix) { - auto &t_clone{Fix::tensor_field.get_zeros_like("tensor clone")}; + auto & t_clone{Fix::tensor_field.get_zeros_like("tensor clone")}; static_assert(std::is_same, typename Fix::TField_t>::value, "wrong overloaded function"); - auto &m_clone{Fix::matrix_field.get_zeros_like("matrix clone")}; + auto & m_clone{Fix::matrix_field.get_zeros_like("matrix clone")}; static_assert(std::is_same, typename Fix::MField_t>::value, "wrong overloaded function"); using FieldColl_t = typename Fix::FieldColl_t; using T = typename Fix::TField_t::Scalar; - TypedField &t_ref{t_clone}; + TypedField & t_ref{t_clone}; - auto &typed_clone{t_ref.get_zeros_like("dynamically sized clone")}; + auto & typed_clone{t_ref.get_zeros_like("dynamically sized clone")}; static_assert(std::is_same, TypedField>::value, "Field type incorrectly deduced"); BOOST_CHECK_EQUAL(typed_clone.get_nb_components(), t_clone.get_nb_components()); - auto &dyn_clone{Fix::dynamic_field1.get_zeros_like("dynamic clone")}; + auto & dyn_clone{Fix::dynamic_field1.get_zeros_like("dynamic clone")}; static_assert( std::is_same::value, "mismatch"); BOOST_CHECK_EQUAL(typed_clone.get_nb_components(), dyn_clone.get_nb_components()); } /* ---------------------------------------------------------------------- */ BOOST_AUTO_TEST_CASE(fill_global_local) { FieldFixture global; FieldFixture local; constexpr Dim_t len{2}; constexpr auto sizes{CcoordOps::get_cube::SDim>(len)}; global.fc.initialise(sizes, {}); local.fc.add_pixel({1, 1}); local.fc.add_pixel({0, 1}); local.fc.initialise(); // fill the local matrix field and then transfer it to the global field for (auto mat : local.matrix_field.get_map()) { mat.setRandom(); } global.matrix_field.fill_from_local(local.matrix_field); - for (const auto &ccoord : local.fc) { - const auto &a{local.matrix_field.get_map()[ccoord]}; - const auto &b{global.matrix_field.get_map()[ccoord]}; + for (const auto & ccoord : local.fc) { + const auto & a{local.matrix_field.get_map()[ccoord]}; + const auto & b{global.matrix_field.get_map()[ccoord]}; const Real error{(a - b).norm()}; BOOST_CHECK_EQUAL(error, 0.); } // fill the global tensor field and then transfer it to the global field for (auto mat : global.tensor_field.get_map()) { mat.setRandom(); } local.tensor_field.fill_from_global(global.tensor_field); - for (const auto &ccoord : local.fc) { - const auto &a{local.matrix_field.get_map()[ccoord]}; - const auto &b{global.matrix_field.get_map()[ccoord]}; + for (const auto & ccoord : local.fc) { + const auto & a{local.matrix_field.get_map()[ccoord]}; + const auto & b{global.matrix_field.get_map()[ccoord]}; const Real error{(a - b).norm()}; BOOST_CHECK_EQUAL(error, 0.); } BOOST_CHECK_THROW(local.tensor_field.fill_from_global(global.matrix_field), std::runtime_error); BOOST_CHECK_THROW(global.tensor_field.fill_from_local(local.matrix_field), std::runtime_error); } BOOST_AUTO_TEST_SUITE_END(); } // namespace muSpectre diff --git a/tests/header_test_raw_field_map.cc b/tests/header_test_raw_field_map.cc index c56e67b..40b01fb 100644 --- a/tests/header_test_raw_field_map.cc +++ b/tests/header_test_raw_field_map.cc @@ -1,100 +1,100 @@ /** * file header_test_raw_field_map.cc * * @author Till Junge * * @date 17 Apr 2018 * * @brief tests for the raw field map type * * @section LICENSE * * Copyright © 2018 Till Junge * * µSpectre 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, 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 Lesser General Public License * along with µSpectre; see the file COPYING. If not, write to the * Free Software Foundation, Inc., 59 Temple Place - Suite 330, * * Boston, MA 02111-1307, USA. * * Additional permission under GNU GPL version 3 section 7 * * If you modify this Program, or any covered work, by linking or combining it * with proprietary FFT implementations or numerical libraries, containing parts * covered by the terms of those libraries' licenses, the licensors of this * Program grant you additional permission to convey the resulting work. */ #include "test_field_collections.hh" #include "common/field_map.hh" namespace muSpectre { BOOST_AUTO_TEST_SUITE(raw_field_map_tests); BOOST_FIXTURE_TEST_CASE_TEMPLATE(iter_field_test, F, iter_collections, F) { using FC_t = typename F::Parent::FC_t; using MSqMap = MatrixFieldMap; MSqMap Mmap{F::fc["Tensorfield Real o2"]}; auto m_it = Mmap.begin(); auto m_it_end = Mmap.end(); RawFieldMap< Eigen::Map>> raw_map{Mmap.get_field().eigenvec()}; - for (auto &&mat : Mmap) { + for (auto && mat : Mmap) { mat.setRandom(); } for (auto tup : akantu::zip(Mmap, raw_map)) { - auto &mat_A = std::get<0>(tup); - auto &mat_B = std::get<1>(tup); + auto & mat_A = std::get<0>(tup); + auto & mat_B = std::get<1>(tup); BOOST_CHECK_EQUAL((mat_A - mat_B).norm(), 0.); } Mmap.get_field().eigenvec().setZero(); - for (auto &&mat : raw_map) { + for (auto && mat : raw_map) { mat.setIdentity(); } - for (auto &&mat : Mmap) { + for (auto && mat : Mmap) { BOOST_CHECK_EQUAL((mat - mat.Identity()).norm(), 0.); } } BOOST_AUTO_TEST_CASE(Const_correctness_test) { Eigen::VectorXd vec1(12); vec1.setRandom(); RawFieldMap> map1{vec1}; static_assert(not map1.IsConst, "should not have been const"); RawFieldMap> cmap1{vec1}; static_assert(cmap1.IsConst, "should have been const"); const Eigen::VectorXd vec2{vec1}; RawFieldMap> cmap2{vec2}; } BOOST_AUTO_TEST_CASE(incompatible_size_check) { Eigen::VectorXd vec1(11); using RawFieldMap_t = RawFieldMap>; BOOST_CHECK_THROW(RawFieldMap_t{vec1}, std::runtime_error); } BOOST_AUTO_TEST_SUITE_END(); } // namespace muSpectre diff --git a/tests/header_test_statefields.cc b/tests/header_test_statefields.cc index 1ac86c3..e409c2b 100644 --- a/tests/header_test_statefields.cc +++ b/tests/header_test_statefields.cc @@ -1,296 +1,299 @@ /** * file header_test_statefields.cc * * @author Till Junge * * @date 01 Mar 2018 * * @brief Test the StateField abstraction and the associated maps * * @section LICENSE * * Copyright © 2018 Till Junge * * µSpectre 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, 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 Lesser General Public License * along with µSpectre; see the file COPYING. If not, write to the * Free Software Foundation, Inc., 59 Temple Place - Suite 330, * * Boston, MA 02111-1307, USA. * * Additional permission under GNU GPL version 3 section 7 * * If you modify this Program, or any covered work, by linking or combining it * with proprietary FFT implementations or numerical libraries, containing parts * covered by the terms of those libraries' licenses, the licensors of this * Program grant you additional permission to convey the resulting work. */ #include "common/field.hh" #include "common/field_collection.hh" #include "common/statefield.hh" #include "common/ccoord_operations.hh" #include "tests.hh" #include #include namespace muSpectre { - template struct SF_Fixture { + template + struct SF_Fixture { using FC_t = std::conditional_t, LocalFieldCollection>; using Field_t = TensorField; using ScalField_t = ScalarField; constexpr static size_t nb_mem{2}; constexpr static Dim_t sdim{DimS}; constexpr static Dim_t mdim{DimM}; constexpr static bool global{Global}; constexpr static size_t get_nb_mem() { return nb_mem; } constexpr static Dim_t get_sdim() { return sdim; } constexpr static Dim_t get_mdim() { return mdim; } constexpr static bool get_global() { return global; } SF_Fixture() : fc{}, sf{make_statefield>("prefix", fc)}, scalar_f{ make_statefield>("scalar", fc)}, self{*this} {} FC_t fc; - StateField &sf; - StateField &scalar_f; - SF_Fixture &self; + StateField & sf; + StateField & scalar_f; + SF_Fixture & self; }; using typelist = boost::mpl::list< SF_Fixture, SF_Fixture, SF_Fixture, SF_Fixture, SF_Fixture, SF_Fixture>; BOOST_AUTO_TEST_SUITE(statefield); BOOST_AUTO_TEST_CASE(old_values_test) { constexpr Dim_t Dim{twoD}; constexpr size_t NbMem{2}; constexpr bool verbose{false}; using FC_t = LocalFieldCollection; FC_t fc{}; using Field_t = ScalarField; - auto &statefield{make_statefield>("name", fc)}; + auto & statefield{make_statefield>("name", fc)}; fc.add_pixel({}); fc.initialise(); for (size_t i{0}; i < NbMem + 1; ++i) { statefield.current().eigen() = i + 1; if (verbose) { std::cout << "current = " << statefield.current().eigen() << std::endl << "old 1 = " << statefield.old().eigen() << std::endl << "old 2 = " << statefield.template old<2>().eigen() << std::endl << "indices = " << statefield.get_indices() << std::endl << std::endl; } statefield.cycle(); } BOOST_CHECK_EQUAL(statefield.current().eigen()(0), 1); BOOST_CHECK_EQUAL(statefield.old().eigen()(0), 3); BOOST_CHECK_EQUAL(statefield.template old<2>().eigen()(0), 2); } BOOST_FIXTURE_TEST_CASE_TEMPLATE(constructor_test, Fix, typelist, Fix) { const std::string ref{"prefix"}; - const std::string &fix{Fix::sf.get_prefix()}; + const std::string & fix{Fix::sf.get_prefix()}; BOOST_CHECK_EQUAL(ref, fix); } namespace internal { - template struct init { - static void run(Fixture_t &fix) { + template + struct init { + static void run(Fixture_t & fix) { constexpr Dim_t dim{std::remove_reference_t::sdim}; fix.fc.initialise(CcoordOps::get_cube(3), CcoordOps::get_cube(0)); } }; - template struct init { - static void run(Fixture_t &fix) { + template + struct init { + static void run(Fixture_t & fix) { constexpr Dim_t dim{std::remove_reference_t::sdim}; CcoordOps::Pixels pixels(CcoordOps::get_cube(3), CcoordOps::get_cube(0)); - for (auto &&pix : pixels) { + for (auto && pix : pixels) { fix.fc.add_pixel(pix); } fix.fc.initialise(); } }; } // namespace internal BOOST_FIXTURE_TEST_CASE_TEMPLATE(test_iteration, Fix, typelist, Fix) { internal::init::run(Fix::self); constexpr Dim_t mdim{Fix::mdim}; constexpr bool verbose{false}; using StateFMap = StateFieldMap, Fix::nb_mem>; StateFMap matrix_map(Fix::sf); for (size_t i = 0; i < Fix::nb_mem + 1; ++i) { - for (auto &&wrapper : matrix_map) { + for (auto && wrapper : matrix_map) { wrapper.current() += (i + 1) * wrapper.current().Identity(); if (verbose) { std::cout << "pixel " << wrapper.get_ccoord() << ", memory cycle " << i << std::endl; std::cout << wrapper.current() << std::endl; std::cout << wrapper.old() << std::endl; std::cout << wrapper.template old<2>() << std::endl << std::endl; } } Fix::sf.cycle(); } - for (auto &&wrapper : matrix_map) { + for (auto && wrapper : matrix_map) { auto I{wrapper.current().Identity()}; Real error{(wrapper.current() - I).norm()}; BOOST_CHECK_LT(error, tol); error = (wrapper.old() - 3 * I).norm(); BOOST_CHECK_LT(error, tol); error = (wrapper.template old<2>() - 2 * I).norm(); BOOST_CHECK_LT(error, tol); } } BOOST_FIXTURE_TEST_CASE_TEMPLATE(test_default_map, Fix, typelist, Fix) { internal::init::run(Fix::self); constexpr bool verbose{false}; auto matrix_map{Fix::sf.get_map()}; for (size_t i = 0; i < Fix::nb_mem + 1; ++i) { - for (auto &&wrapper : matrix_map) { + for (auto && wrapper : matrix_map) { wrapper.current() += (i + 1) * wrapper.current().Identity(); if (verbose) { std::cout << "pixel " << wrapper.get_ccoord() << ", memory cycle " << i << std::endl; std::cout << wrapper.current() << std::endl; std::cout << wrapper.old() << std::endl; std::cout << wrapper.template old<2>() << std::endl << std::endl; } } Fix::sf.cycle(); } auto matrix_const_map{Fix::sf.get_const_map()}; - for (auto &&wrapper : matrix_const_map) { + for (auto && wrapper : matrix_const_map) { auto I{wrapper.current().Identity()}; Real error{(wrapper.current() - I).norm()}; BOOST_CHECK_LT(error, tol); error = (wrapper.old() - 3 * I).norm(); BOOST_CHECK_LT(error, tol); error = (wrapper.template old<2>() - 2 * I).norm(); BOOST_CHECK_LT(error, tol); } } BOOST_FIXTURE_TEST_CASE_TEMPLATE(test_scalar_map, Fix, typelist, Fix) { internal::init::run(Fix::self); constexpr bool verbose{false}; auto scalar_map{Fix::scalar_f.get_map()}; for (size_t i = 0; i < Fix::nb_mem + 1; ++i) { - for (auto &&wrapper : scalar_map) { + for (auto && wrapper : scalar_map) { wrapper.current() += (i + 1); if (verbose) { std::cout << "pixel " << wrapper.get_ccoord() << ", memory cycle " << i << std::endl; std::cout << wrapper.current() << std::endl; std::cout << wrapper.old() << std::endl; std::cout << wrapper.template old<2>() << std::endl << std::endl; } } Fix::scalar_f.cycle(); } auto scalar_const_map{Fix::scalar_f.get_const_map()}; BOOST_CHECK_EQUAL(scalar_const_map[0].current(), scalar_const_map[1].current()); for (auto wrapper : scalar_const_map) { Real error{wrapper.current() - 1}; BOOST_CHECK_LT(error, tol); error = wrapper.old() - 3; BOOST_CHECK_LT(error, tol); error = wrapper.template old<2>() - 2; BOOST_CHECK_LT(error, tol); } } /* ---------------------------------------------------------------------- */ BOOST_FIXTURE_TEST_CASE_TEMPLATE(Polymorphic_access_by_name, Fix, typelist, Fix) { internal::init::run(Fix::self); // constexpr bool verbose{true}; - auto &tensor_field = Fix::fc.get_statefield("prefix"); + auto & tensor_field = Fix::fc.get_statefield("prefix"); BOOST_CHECK_EQUAL(tensor_field.get_nb_memory(), Fix::get_nb_mem()); - auto &field = Fix::fc.template get_current("prefix"); + auto & field = Fix::fc.template get_current("prefix"); BOOST_CHECK_EQUAL(field.get_nb_components(), ipow(Fix::get_mdim(), secondOrder)); BOOST_CHECK_THROW(Fix::fc.template get_current("prefix"), std::runtime_error); - auto &old_field = Fix::fc.template get_old("prefix"); + auto & old_field = Fix::fc.template get_old("prefix"); BOOST_CHECK_EQUAL(old_field.get_nb_components(), field.get_nb_components()); BOOST_CHECK_THROW( Fix::fc.template get_old("prefix", Fix::get_nb_mem() + 1), std::out_of_range); - auto &statefield{Fix::fc.get_statefield("prefix")}; - auto &typed_statefield{ + auto & statefield{Fix::fc.get_statefield("prefix")}; + auto & typed_statefield{ Fix::fc.template get_typed_statefield("prefix")}; auto map{ArrayFieldMap( typed_statefield.get_current_field())}; for (auto arr : map) { arr.setConstant(1); } Eigen::ArrayXXd field_copy{field.eigen()}; statefield.cycle(); - auto &alt_old_field{typed_statefield.get_old_field()}; + auto & alt_old_field{typed_statefield.get_old_field()}; Real err{(field_copy - alt_old_field.eigen()).matrix().norm() / field_copy.matrix().norm()}; BOOST_CHECK_LT(err, tol); if (not(err < tol)) { std::cout << field_copy << std::endl << std::endl << typed_statefield.get_current_field().eigen() << std::endl << std::endl << typed_statefield.get_old_field(1).eigen() << std::endl << std::endl << typed_statefield.get_old_field(2).eigen() << std::endl; } } BOOST_AUTO_TEST_SUITE_END(); } // namespace muSpectre diff --git a/tests/header_test_t4_map.cc b/tests/header_test_t4_map.cc index 7fba88d..98b2afc 100644 --- a/tests/header_test_t4_map.cc +++ b/tests/header_test_t4_map.cc @@ -1,123 +1,124 @@ /** * @file header_test_t4_map.cc * * @author Till Junge * * @date 20 Nov 2017 * * @brief Test the fourth-order map on second-order tensor implementation * * Copyright © 2017 Till Junge * * µSpectre 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, 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 Lesser General Public License * along with µSpectre; see the file COPYING. If not, write to the * Free Software Foundation, Inc., 59 Temple Place - Suite 330, * * Boston, MA 02111-1307, USA. * * Additional permission under GNU GPL version 3 section 7 * * If you modify this Program, or any covered work, by linking or combining it * with proprietary FFT implementations or numerical libraries, containing parts * covered by the terms of those libraries' licenses, the licensors of this * Program grant you additional permission to convey the resulting work. */ #include #include #include #include #include "common/common.hh" #include "tests.hh" #include "common/T4_map_proxy.hh" namespace muSpectre { BOOST_AUTO_TEST_SUITE(T4map_tests); /** * Test fixture for construction of T4Map for the time being, symmetry is not * exploited */ - template struct T4_fixture { + template + struct T4_fixture { T4_fixture() : matrix{}, tensor(matrix.data()) {} EIGEN_MAKE_ALIGNED_OPERATOR_NEW; using M4 = T4Mat; using T4 = T4MatMap; constexpr static Dim_t dim{Dim}; M4 matrix; T4 tensor; }; using fix_collection = boost::mpl::list, T4_fixture>; BOOST_FIXTURE_TEST_CASE_TEMPLATE(Simple_construction_test, F, fix_collection, F) { BOOST_CHECK_EQUAL(F::tensor.cols(), F::dim * F::dim); } BOOST_FIXTURE_TEST_CASE_TEMPLATE(write_access_test, F, fix_collection, F) { - auto &t4 = F::tensor; + auto & t4 = F::tensor; constexpr Dim_t dim{F::dim}; Eigen::TensorFixedSize> t4c; Eigen::Map t4c_map(t4c.data()); for (Dim_t i = 0; i < F::dim; ++i) { for (Dim_t j = 0; j < F::dim; ++j) { for (Dim_t k = 0; k < F::dim; ++k) { for (Dim_t l = 0; l < F::dim; ++l) { get(t4, i, j, k, l) = 1000 * (i + 1) + 100 * (j + 1) + 10 * (k + 1) + l + 1; t4c(i, j, k, l) = 1000 * (i + 1) + 100 * (j + 1) + 10 * (k + 1) + l + 1; } } } } for (Dim_t i = 0; i < ipow(dim, 4); ++i) { BOOST_CHECK_EQUAL(F::matrix.data()[i], t4c.data()[i]); } } BOOST_FIXTURE_TEST_CASE_TEMPLATE(assign_matrix_test, F, fix_collection, F) { decltype(F::matrix) matrix; matrix.setRandom(); F::tensor = matrix; for (Dim_t i = 0; i < ipow(F::dim, 4); ++i) { BOOST_CHECK_EQUAL(F::matrix.data()[i], matrix.data()[i]); } } BOOST_AUTO_TEST_CASE(Return_ref_from_const_test) { constexpr Dim_t dim{2}; using T = int; using M4 = Eigen::Matrix; using M4c = const Eigen::Matrix; using T4 = T4MatMap; using T4c = T4MatMap; M4 mat; mat.setRandom(); M4c cmat{mat}; T4 tensor{mat.data()}; T4c ctensor{mat.data()}; T a = get(tensor, 0, 0, 0, 1); T b = get(ctensor, 0, 0, 0, 1); BOOST_CHECK_EQUAL(a, b); } BOOST_AUTO_TEST_SUITE_END(); } // namespace muSpectre diff --git a/tests/header_test_tensor_algebra.cc b/tests/header_test_tensor_algebra.cc index 2cb506e..7db7f91 100644 --- a/tests/header_test_tensor_algebra.cc +++ b/tests/header_test_tensor_algebra.cc @@ -1,296 +1,296 @@ /** * @file header_test_tensor_algebra.cc * * @author Till Junge * * @date 05 Nov 2017 * * @brief Tests for the tensor algebra functions * * Copyright © 2017 Till Junge * * µSpectre 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, 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 Lesser General Public License * along with µSpectre; see the file COPYING. If not, write to the * Free Software Foundation, Inc., 59 Temple Place - Suite 330, * * Boston, MA 02111-1307, USA. * * Additional permission under GNU GPL version 3 section 7 * * If you modify this Program, or any covered work, by linking or combining it * with proprietary FFT implementations or numerical libraries, containing parts * covered by the terms of those libraries' licenses, the licensors of this * Program grant you additional permission to convey the resulting work. */ #include #include #include "common/tensor_algebra.hh" #include "tests.hh" #include "tests/test_goodies.hh" namespace muSpectre { BOOST_AUTO_TEST_SUITE(tensor_algebra) - auto TerrNorm = [](auto &&t) { + auto TerrNorm = [](auto && t) { return Eigen::Tensor(t.abs().sum())(); }; /* ---------------------------------------------------------------------- */ BOOST_AUTO_TEST_CASE(tensor_outer_product_test) { constexpr Dim_t dim{2}; Eigen::TensorFixedSize> A, B; // use prime numbers so that every multiple is uniquely identifiable A.setValues({{1, 2}, {3, 7}}); B.setValues({{11, 13}, {17, 19}}); Eigen::TensorFixedSize> Res1, Res2, Res3; for (Dim_t i = 0; i < dim; ++i) { for (Dim_t j = 0; j < dim; ++j) { for (Dim_t k = 0; k < dim; ++k) { for (Dim_t l = 0; l < dim; ++l) { Res1(i, j, k, l) = A(i, j) * B(k, l); Res2(i, j, k, l) = A(i, k) * B(j, l); Res3(i, j, k, l) = A(i, l) * B(j, k); } } } } Real error = TerrNorm(Res1 - Tensors::outer(A, B)); BOOST_CHECK_LT(error, tol); error = TerrNorm(Res2 - Tensors::outer_under(A, B)); BOOST_CHECK_LT(error, tol); error = TerrNorm(Res3 - Tensors::outer_over(A, B)); if (error > tol) { std::cout << "reference:" << std::endl << Res3 << std::endl; std::cout << "result:" << std::endl << Tensors::outer_over(A, B) << std::endl; std::cout << "A:" << std::endl << A << std::endl; std::cout << "B" << std::endl << B << std::endl; decltype(Res3) tmp = Tensors::outer_over(A, B); for (Dim_t i = 0; i < dim; ++i) { for (Dim_t j = 0; j < dim; ++j) { for (Dim_t k = 0; k < dim; ++k) { for (Dim_t l = 0; l < dim; ++l) { std::cout << "for (" << i << ", " << j << ", " << k << ", " << l << "), ref: " << std::setw(3) << Res3(i, j, k, l) << ", res: " << std::setw(3) << tmp(i, j, k, l) << std::endl; } } } } } BOOST_CHECK_LT(error, tol); error = TerrNorm(Res3 - Tensors::outer(A, B)); BOOST_CHECK_GT(error, tol); }; BOOST_FIXTURE_TEST_CASE_TEMPLATE(outer_products, Fix, testGoodies::dimlist, Fix) { constexpr auto dim{Fix::dim}; using T2 = Tensors::Tens2_t; using M2 = Matrices::Tens2_t; using Map2 = Eigen::Map; using T4 = Tensors::Tens4_t; using M4 = Matrices::Tens4_t; using Map4 = Eigen::Map; T2 A, B; T4 RT; A.setRandom(); B.setRandom(); Map2 Amap(A.data()); Map2 Bmap(B.data()); M2 C, D; M4 RM; C = Amap; D = Bmap; - auto error = [](const T4 &A, const M4 &B) { + auto error = [](const T4 & A, const M4 & B) { return (B - Map4(A.data())).norm(); }; // Check outer product RT = Tensors::outer(A, B); RM = Matrices::outer(C, D); BOOST_CHECK_LT(error(RT, RM), tol); // Check outer_under product RT = Tensors::outer_under(A, B); RM = Matrices::outer_under(C, D); BOOST_CHECK_LT(error(RT, RM), tol); // Check outer_over product RT = Tensors::outer_over(A, B); RM = Matrices::outer_over(C, D); BOOST_CHECK_LT(error(RT, RM), tol); } BOOST_AUTO_TEST_CASE(tensor_multiplication) { constexpr Dim_t dim{2}; using Strain_t = Eigen::TensorFixedSize>; Strain_t A, B; A.setValues({{1, 2}, {3, 7}}); B.setValues({{11, 13}, {17, 19}}); Strain_t FF1 = A * B; // element-wise multiplication std::array, 1> prod_dims{Eigen::IndexPair{1, 0}}; Strain_t FF2 = A.contract(B, prod_dims); // correct option 1 Strain_t FF3; using Mat_t = Eigen::Map>; // following only works for evaluated tensors (which already have data()) Mat_t(FF3.data()) = Mat_t(A.data()) * Mat_t(B.data()); Strain_t ref; ref.setZero(); for (Dim_t i = 0; i < dim; ++i) { for (Dim_t j = 0; j < dim; ++j) { for (Dim_t a = 0; a < dim; ++a) { ref(i, j) += A(i, a) * B(a, j); } } } using Strain_tw = Eigen::TensorFixedSize>; Strain_tw C; C.setConstant(100); // static_assert(!std::is_convertible::value, // "Tensors not size-protected"); if (std::is_convertible::value) { // std::cout << "this is not good, should I abandon Tensors?"; } // this test seems useless. I use to detect if Eigen changed the // default tensor product Real error = TerrNorm(FF1 - ref); if (error < tol) { std::cout << "A =" << std::endl << A << std::endl; std::cout << "B =" << std::endl << B << std::endl; std::cout << "FF1 =" << std::endl << FF1 << std::endl; std::cout << "ref =" << std::endl << ref << std::endl; } BOOST_CHECK_GT(error, tol); error = TerrNorm(FF2 - ref); if (error > tol) { std::cout << "A =" << std::endl << A << std::endl; std::cout << "B =" << std::endl << B << std::endl; std::cout << "FF2 =" << std::endl << FF2 << std::endl; std::cout << "ref =" << std::endl << ref << std::endl; } BOOST_CHECK_LT(error, tol); error = TerrNorm(FF3 - ref); if (error > tol) { std::cout << "A =" << std::endl << A << std::endl; std::cout << "B =" << std::endl << B << std::endl; std::cout << "FF3 =" << std::endl << FF3 << std::endl; std::cout << "ref =" << std::endl << ref << std::endl; } BOOST_CHECK_LT(error, tol); } BOOST_FIXTURE_TEST_CASE_TEMPLATE(test_tensmult, Fix, testGoodies::dimlist, Fix) { - using Matrices::tensmult; - using Matrices::Tens4_t; using Matrices::Tens2_t; + using Matrices::Tens4_t; + using Matrices::tensmult; constexpr Dim_t dim{Fix::dim}; using T4 = Tens4_t; using T2 = Tens2_t; using V2 = Eigen::Matrix; T4 C; C.setRandom(); T2 E; E.setRandom(); Eigen::Map Ev(E.data()); T2 R = tensmult(C, E); auto error = (Eigen::Map(R.data()) - C * Ev).norm(); BOOST_CHECK_LT(error, tol); } BOOST_FIXTURE_TEST_CASE_TEMPLATE(test_tracer, Fix, testGoodies::dimlist, Fix) { - using Matrices::tensmult; - using Matrices::Tens4_t; using Matrices::Tens2_t; + using Matrices::Tens4_t; + using Matrices::tensmult; constexpr Dim_t dim{Fix::dim}; using T2 = Tens2_t; auto tracer = Matrices::Itrac(); T2 F; F.setRandom(); auto Ftrac = tensmult(tracer, F); auto error = (Ftrac - F.trace() * F.Identity()).norm(); BOOST_CHECK_LT(error, tol); } BOOST_FIXTURE_TEST_CASE_TEMPLATE(test_identity, Fix, testGoodies::dimlist, Fix) { - using Matrices::tensmult; - using Matrices::Tens4_t; using Matrices::Tens2_t; + using Matrices::Tens4_t; + using Matrices::tensmult; constexpr Dim_t dim{Fix::dim}; using T2 = Tens2_t; auto ident = Matrices::Iiden(); T2 F; F.setRandom(); auto Fiden = tensmult(ident, F); auto error = (Fiden - F).norm(); BOOST_CHECK_LT(error, tol); } BOOST_FIXTURE_TEST_CASE_TEMPLATE(test_transposer, Fix, testGoodies::dimlist, Fix) { - using Matrices::tensmult; - using Matrices::Tens4_t; using Matrices::Tens2_t; + using Matrices::Tens4_t; + using Matrices::tensmult; constexpr Dim_t dim{Fix::dim}; using T2 = Tens2_t; auto trnst = Matrices::Itrns(); T2 F; F.setRandom(); auto Ftrns = tensmult(trnst, F); auto error = (Ftrns - F.transpose()).norm(); BOOST_CHECK_LT(error, tol); } BOOST_FIXTURE_TEST_CASE_TEMPLATE(test_symmetriser, Fix, testGoodies::dimlist, Fix) { - using Matrices::tensmult; - using Matrices::Tens4_t; using Matrices::Tens2_t; + using Matrices::Tens4_t; + using Matrices::tensmult; constexpr Dim_t dim{Fix::dim}; using T2 = Tens2_t; auto symmt = Matrices::Isymm(); T2 F; F.setRandom(); auto Fsymm = tensmult(symmt, F); auto error = (Fsymm - .5 * (F + F.transpose())).norm(); BOOST_CHECK_LT(error, tol); } BOOST_AUTO_TEST_SUITE_END(); } // namespace muSpectre diff --git a/tests/main_test_suite.cc b/tests/main_test_suite.cc index 3144742..6e5e995 100644 --- a/tests/main_test_suite.cc +++ b/tests/main_test_suite.cc @@ -1,40 +1,39 @@ /** * @file main_test_suite.cc * * @author Till Junge * * @date 01 May 2017 * * @brief Main test suite. Running this suite tests all available tests for * µSpectre * * Copyright © 2017 Till Junge * * µSpectre 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, 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 Lesser General Public License * along with µSpectre; see the file COPYING. If not, write to the * Free Software Foundation, Inc., 59 Temple Place - Suite 330, * * Boston, MA 02111-1307, USA. * * Additional permission under GNU GPL version 3 section 7 * * If you modify this Program, or any covered work, by linking or combining it * with proprietary FFT implementations or numerical libraries, containing parts * covered by the terms of those libraries' licenses, the licensors of this * Program grant you additional permission to convey the resulting work. */ #define BOOST_TEST_MODULE base_test test #define BOOST_TEST_MAIN #define BOOST_TEST_DYN_LINK #include - diff --git a/tests/mpi_context.hh b/tests/mpi_context.hh index dd6da03..88536d6 100644 --- a/tests/mpi_context.hh +++ b/tests/mpi_context.hh @@ -1,71 +1,71 @@ /** * @file mpi_initializer.cc * * @author Lars Pastewka * * @date 07 Mar 2018 * * @brief Singleton for initialization and tear down of MPI. * * Copyright © 2017 Till Junge * * µSpectre 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, 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 Lesser General Public License * along with µSpectre; see the file COPYING. If not, write to the * Free Software Foundation, Inc., 59 Temple Place - Suite 330, * * Boston, MA 02111-1307, USA. * * Additional permission under GNU GPL version 3 section 7 * * If you modify this Program, or any covered work, by linking or combining it * with proprietary FFT implementations or numerical libraries, containing parts * covered by the terms of those libraries' licenses, the licensors of this * Program grant you additional permission to convey the resulting work. */ #ifndef TESTS_MPI_CONTEXT_HH_ #define TESTS_MPI_CONTEXT_HH_ #include "common/communicator.hh" namespace muSpectre { /*! * MPI context singleton. Initialize MPI once when needed. */ class MPIContext { public: Communicator comm; - static MPIContext &get_context() { + static MPIContext & get_context() { static MPIContext context; return context; } private: MPIContext() : comm(Communicator(MPI_COMM_WORLD)) { MPI_Init(&boost::unit_test::framework::master_test_suite().argc, &boost::unit_test::framework::master_test_suite().argv); } ~MPIContext() { // Wait for all processes to finish before calling finalize. MPI_Barrier(comm.get_mpi_comm()); MPI_Finalize(); } public: MPIContext(MPIContext const &) = delete; void operator=(MPIContext const &) = delete; }; } // namespace muSpectre #endif // TESTS_MPI_CONTEXT_HH_ diff --git a/tests/mpi_main_test_suite.cc b/tests/mpi_main_test_suite.cc index 77693b8..a80803d 100644 --- a/tests/mpi_main_test_suite.cc +++ b/tests/mpi_main_test_suite.cc @@ -1,40 +1,39 @@ /** * @file mpi_main_test_suite.cc * * @author Lars Pastewka * * @date 07 Mar 2018 * * @brief Main test suite for MPI specific modules. Running this suite tests * all available tests for µSpectre that depend on MPI. * * Copyright © 2017 Till Junge * * µSpectre 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, 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 Lesser General Public License * along with µSpectre; see the file COPYING. If not, write to the * Free Software Foundation, Inc., 59 Temple Place - Suite 330, * * Boston, MA 02111-1307, USA. * * Additional permission under GNU GPL version 3 section 7 * * If you modify this Program, or any covered work, by linking or combining it * with proprietary FFT implementations or numerical libraries, containing parts * covered by the terms of those libraries' licenses, the licensors of this * Program grant you additional permission to convey the resulting work. */ #define BOOST_TEST_MODULE base_test test #define BOOST_TEST_MAIN #define BOOST_TEST_DYN_LINK #include - diff --git a/tests/mpi_test_fft_engine.cc b/tests/mpi_test_fft_engine.cc index 8c5d2d7..3658a73 100644 --- a/tests/mpi_test_fft_engine.cc +++ b/tests/mpi_test_fft_engine.cc @@ -1,181 +1,182 @@ /** * @file mpi_test_fft_engine.cc * * @author Lars Pastewka * * @date 06 Mar 2017 * * @brief tests for MPI-parallel fft engine implementations * * Copyright © 2017 Till Junge * * µSpectre 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, 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 Lesser General Public License * along with µSpectre; see the file COPYING. If not, write to the * Free Software Foundation, Inc., 59 Temple Place - Suite 330, * * Boston, MA 02111-1307, USA. * * Additional permission under GNU GPL version 3 section 7 * * If you modify this Program, or any covered work, by linking or combining it * with proprietary FFT implementations or numerical libraries, containing parts * covered by the terms of those libraries' licenses, the licensors of this * Program grant you additional permission to convey the resulting work. */ #define BOOST_MPL_CFG_NO_PREPROCESSED_HEADERS #define BOOST_MPL_LIMIT_LIST_SIZE 50 #include #include "tests.hh" #include "mpi_context.hh" #include "fft/fftw_engine.hh" #ifdef WITH_FFTWMPI #include "fft/fftwmpi_engine.hh" #endif #ifdef WITH_PFFT #include "fft/pfft_engine.hh" #endif #include "common/ccoord_operations.hh" #include "common/field_collection.hh" #include "common/field_map.hh" #include "common/iterators.hh" namespace muSpectre { BOOST_AUTO_TEST_SUITE(mpi_fft_engine); /* ---------------------------------------------------------------------- */ template struct FFTW_fixture { constexpr static Dim_t box_resolution{resolution}; constexpr static Dim_t serial_engine{serial}; constexpr static Real box_length{4.5}; constexpr static Dim_t sdim{Engine::sdim}; constexpr static Dim_t nb_components{sdim * sdim}; constexpr static Ccoord_t res() { return CcoordOps::get_cube(box_resolution); } FFTW_fixture() : engine(res(), nb_components, MPIContext::get_context().comm) {} Engine engine; }; - template struct FFTW_fixture_python_segfault { + template + struct FFTW_fixture_python_segfault { constexpr static Dim_t serial_engine{false}; constexpr static Dim_t dim{twoD}; constexpr static Dim_t sdim{twoD}; constexpr static Dim_t mdim{twoD}; constexpr static Ccoord_t res() { return {6, 4}; } FFTW_fixture_python_segfault() : engine{res(), MPIContext::get_context().comm} {} Engine engine; }; using fixlist = boost::mpl::list< #ifdef WITH_FFTWMPI FFTW_fixture, 3>, FFTW_fixture, 3>, FFTW_fixture, 4>, FFTW_fixture, 4>, FFTW_fixture_python_segfault>, #endif #ifdef WITH_PFFT FFTW_fixture, 3>, FFTW_fixture, 3>, FFTW_fixture, 4>, FFTW_fixture, 4>, FFTW_fixture_python_segfault>, #endif FFTW_fixture, 3, true>>; /* ---------------------------------------------------------------------- */ BOOST_FIXTURE_TEST_CASE_TEMPLATE(Constructor_test, Fix, fixlist, Fix) { - Communicator &comm = MPIContext::get_context().comm; + Communicator & comm = MPIContext::get_context().comm; if (Fix::serial_engine && comm.size() > 1) { return; } else { BOOST_CHECK_NO_THROW(Fix::engine.initialise(FFT_PlanFlags::estimate)); } BOOST_CHECK_EQUAL(comm.sum(Fix::engine.size()), CcoordOps::get_size(Fix::res())); } /* ---------------------------------------------------------------------- */ BOOST_FIXTURE_TEST_CASE_TEMPLATE(fft_test, Fix, fixlist, Fix) { if (Fix::serial_engine && Fix::engine.get_communicator().size() > 1) { // dont test serial engies in parallel return; } else { Fix::engine.initialise(FFT_PlanFlags::estimate); } constexpr Dim_t order{2}; using FC_t = GlobalFieldCollection; FC_t fc; - auto &input{ + auto & input{ make_field>("input", fc)}; - auto &ref{ + auto & ref{ make_field>("reference", fc)}; - auto &result{ + auto & result{ make_field>("result", fc)}; fc.initialise(Fix::engine.get_subdomain_resolutions(), Fix::engine.get_subdomain_locations()); using map_t = MatrixFieldMap; map_t inmap{input}; auto refmap{map_t{ref}}; auto resultmap{map_t{result}}; size_t cntr{0}; for (auto tup : akantu::zip(inmap, refmap)) { cntr++; - auto &in_{std::get<0>(tup)}; - auto &ref_{std::get<1>(tup)}; + auto & in_{std::get<0>(tup)}; + auto & ref_{std::get<1>(tup)}; in_.setRandom(); ref_ = in_; } - auto &complex_field = Fix::engine.fft(input); + auto & complex_field = Fix::engine.fft(input); using cmap_t = MatrixFieldMap, Complex, Fix::sdim, Fix::sdim>; cmap_t complex_map(complex_field); if (Fix::engine.get_subdomain_locations() == CcoordOps::get_cube(0)) { // Check that 0,0 location has no imaginary part. Real error = complex_map[0].imag().norm(); BOOST_CHECK_LT(error, tol); } /* make sure, the engine has not modified input (which is unfortunately const-casted internally, hence this test) */ - for (auto &&tup : akantu::zip(inmap, refmap)) { + for (auto && tup : akantu::zip(inmap, refmap)) { Real error{(std::get<0>(tup) - std::get<1>(tup)).norm()}; BOOST_CHECK_LT(error, tol); } /* make sure that the ifft of fft returns the original*/ Fix::engine.ifft(result); - for (auto &&tup : akantu::zip(resultmap, refmap)) { + for (auto && tup : akantu::zip(resultmap, refmap)) { Real error{ (std::get<0>(tup) * Fix::engine.normalisation() - std::get<1>(tup)) .norm()}; BOOST_CHECK_LT(error, tol); if (error > tol) { std::cout << std::get<0>(tup).array() / std::get<1>(tup).array() << std::endl << std::endl; } } } BOOST_AUTO_TEST_SUITE_END(); } // namespace muSpectre diff --git a/tests/mpi_test_projection.hh b/tests/mpi_test_projection.hh index 5676a9c..f2cb487 100644 --- a/tests/mpi_test_projection.hh +++ b/tests/mpi_test_projection.hh @@ -1,102 +1,107 @@ /** * @file test_projection.hh * * @author Till Junge * * @date 16 Jan 2018 * * @brief common declarations for testing both the small and finite strain * projection operators * * Copyright © 2018 Till Junge * * µSpectre 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, 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 Lesser General Public License * along with µSpectre; see the file COPYING. If not, write to the * Free Software Foundation, Inc., 59 Temple Place - Suite 330, * * Boston, MA 02111-1307, USA. * * Additional permission under GNU GPL version 3 section 7 * * If you modify this Program, or any covered work, by linking or combining it * with proprietary FFT implementations or numerical libraries, containing parts * covered by the terms of those libraries' licenses, the licensors of this * Program grant you additional permission to convey the resulting work. */ #include "tests.hh" #include "mpi_context.hh" #include #include #ifndef TESTS_MPI_TEST_PROJECTION_HH_ #define TESTS_MPI_TEST_PROJECTION_HH_ - namespace muSpectre { /* ---------------------------------------------------------------------- */ - template struct Sizes {}; - template <> struct Sizes { + template + struct Sizes {}; + template <> + struct Sizes { constexpr static Ccoord_t get_resolution() { return Ccoord_t{3, 5}; } constexpr static Rcoord_t get_lengths() { return Rcoord_t{3.4, 5.8}; } }; - template <> struct Sizes { + template <> + struct Sizes { constexpr static Ccoord_t get_resolution() { return Ccoord_t{3, 5, 7}; } constexpr static Rcoord_t get_lengths() { return Rcoord_t{3.4, 5.8, 6.7}; } }; - template struct Squares {}; - template <> struct Squares { + template + struct Squares {}; + template <> + struct Squares { constexpr static Ccoord_t get_resolution() { return Ccoord_t{5, 5}; } constexpr static Rcoord_t get_lengths() { return Rcoord_t{5, 5}; } }; - template <> struct Squares { + template <> + struct Squares { constexpr static Ccoord_t get_resolution() { return Ccoord_t{7, 7, 7}; } constexpr static Rcoord_t get_lengths() { return Rcoord_t{7, 7, 7}; } }; /* ---------------------------------------------------------------------- */ template struct ProjectionFixture { using Parent = Proj; constexpr static Dim_t sdim{DimS}; constexpr static Dim_t mdim{DimM}; constexpr static bool is_parallel{parallel}; ProjectionFixture() : projector(std::make_unique(SizeGiver::get_resolution(), ipow(mdim, 2), MPIContext::get_context().comm), SizeGiver::get_lengths()) {} Parent projector; }; } // namespace muSpectre #endif // TESTS_MPI_TEST_PROJECTION_HH_ diff --git a/tests/mpi_test_projection_finite.cc b/tests/mpi_test_projection_finite.cc index 4178d6d..6af4162 100644 --- a/tests/mpi_test_projection_finite.cc +++ b/tests/mpi_test_projection_finite.cc @@ -1,194 +1,194 @@ /** * @file test_projection_finite.cc * * @author Till Junge * * @date 07 Dec 2017 * * @brief tests for standard finite strain projection operator * * Copyright © 2017 Till Junge * * µSpectre 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, 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 Lesser General Public License * along with µSpectre; see the file COPYING. If not, write to the * Free Software Foundation, Inc., 59 Temple Place - Suite 330, * * Boston, MA 02111-1307, USA. * * Additional permission under GNU GPL version 3 section 7 * * If you modify this Program, or any covered work, by linking or combining it * with proprietary FFT implementations or numerical libraries, containing parts * covered by the terms of those libraries' licenses, the licensors of this * Program grant you additional permission to convey the resulting work. */ #define BOOST_MPL_CFG_NO_PREPROCESSED_HEADERS #define BOOST_MPL_LIMIT_LIST_SIZE 50 #include "fft/projection_finite_strain.hh" #include "fft/projection_finite_strain_fast.hh" #include "fft/fft_utils.hh" #include "mpi_test_projection.hh" #include "fft/fftw_engine.hh" #ifdef WITH_FFTWMPI #include "fft/fftwmpi_engine.hh" #endif #ifdef WITH_PFFT #include "fft/pfft_engine.hh" #endif #include namespace muSpectre { BOOST_AUTO_TEST_SUITE(mpi_projection_finite_strain); /* ---------------------------------------------------------------------- */ using fixlist = boost::mpl::list< #ifdef WITH_FFTWMPI ProjectionFixture, ProjectionFiniteStrain, FFTWMPIEngine>, ProjectionFixture, ProjectionFiniteStrain, FFTWMPIEngine>, ProjectionFixture, ProjectionFiniteStrain, FFTWMPIEngine>, ProjectionFixture, ProjectionFiniteStrain, FFTWMPIEngine>, ProjectionFixture, ProjectionFiniteStrainFast, FFTWMPIEngine>, ProjectionFixture, ProjectionFiniteStrainFast, FFTWMPIEngine>, ProjectionFixture, ProjectionFiniteStrainFast, FFTWMPIEngine>, ProjectionFixture, ProjectionFiniteStrainFast, FFTWMPIEngine>, #endif #ifdef WITH_PFFT ProjectionFixture, ProjectionFiniteStrain, PFFTEngine>, ProjectionFixture, ProjectionFiniteStrain, PFFTEngine>, ProjectionFixture, ProjectionFiniteStrain, PFFTEngine>, ProjectionFixture, ProjectionFiniteStrain, PFFTEngine>, ProjectionFixture, ProjectionFiniteStrainFast, PFFTEngine>, ProjectionFixture, ProjectionFiniteStrainFast, PFFTEngine>, ProjectionFixture, ProjectionFiniteStrainFast, PFFTEngine>, ProjectionFixture, ProjectionFiniteStrainFast, PFFTEngine>, #endif ProjectionFixture, ProjectionFiniteStrain, FFTWEngine, false>>; /* ---------------------------------------------------------------------- */ BOOST_FIXTURE_TEST_CASE_TEMPLATE(constructor_test, fix, fixlist, fix) { if (fix::is_parallel || fix::projector.get_communicator().size() == 1) { BOOST_CHECK_NO_THROW(fix::projector.initialise(FFT_PlanFlags::estimate)); } } /* ---------------------------------------------------------------------- */ BOOST_FIXTURE_TEST_CASE_TEMPLATE(Gradient_preservation_test, fix, fixlist, fix) { if (!fix::is_parallel || fix::projector.get_communicator().size() > 1) { return; } // create a gradient field with a zero mean gradient and verify // that the projection preserves it constexpr Dim_t dim{fix::sdim}, sdim{fix::sdim}, mdim{fix::mdim}; static_assert( dim == fix::mdim, "These tests assume that the material and spatial dimension are " "identical"); using Fields = GlobalFieldCollection; using FieldT = TensorField; using FieldMap = MatrixFieldMap; using Vector = Eigen::Matrix; Fields fields{}; - FieldT &f_grad{make_field("gradient", fields)}; - FieldT &f_var{make_field("working field", fields)}; + FieldT & f_grad{make_field("gradient", fields)}; + FieldT & f_var{make_field("working field", fields)}; FieldMap grad(f_grad); FieldMap var(f_var); fields.initialise(fix::projector.get_subdomain_resolutions(), fix::projector.get_subdomain_locations()); Vector k; for (Dim_t i = 0; i < dim; ++i) { // the wave vector has to be such that it leads to an integer // number of periods in each length of the domain k(i) = (i + 1) * 2 * pi / fix::projector.get_domain_lengths()[i]; } - for (auto &&tup : akantu::zip(fields, grad, var)) { - auto &ccoord = std::get<0>(tup); - auto &g = std::get<1>(tup); - auto &v = std::get<2>(tup); + for (auto && tup : akantu::zip(fields, grad, var)) { + auto & ccoord = std::get<0>(tup); + auto & g = std::get<1>(tup); + auto & v = std::get<2>(tup); Vector vec = CcoordOps::get_vector( ccoord, fix::projector.get_domain_lengths() / fix::projector.get_domain_resolutions()); g.row(0) = k.transpose() * cos(k.dot(vec)); v.row(0) = g.row(0); } fix::projector.initialise(FFT_PlanFlags::estimate); fix::projector.apply_projection(f_var); - for (auto &&tup : akantu::zip(fields, grad, var)) { - auto &ccoord = std::get<0>(tup); - auto &g = std::get<1>(tup); - auto &v = std::get<2>(tup); + for (auto && tup : akantu::zip(fields, grad, var)) { + auto & ccoord = std::get<0>(tup); + auto & g = std::get<1>(tup); + auto & v = std::get<2>(tup); Real error = (g - v).norm(); BOOST_CHECK_LT(error, tol); if (error >= tol) { Vector vec = CcoordOps::get_vector( ccoord, fix::projector.get_domain_lengths() / fix::projector.get_domain_resolutions()); std::cout << std::endl << "grad_ref :" << std::endl << g << std::endl; std::cout << std::endl << "grad_proj :" << std::endl << v << std::endl; std::cout << std::endl << "ccoord :" << std::endl << ccoord << std::endl; std::cout << std::endl << "vector :" << std::endl << vec.transpose() << std::endl; } } } BOOST_AUTO_TEST_SUITE_END(); } // namespace muSpectre diff --git a/tests/mpi_test_projection_small.cc b/tests/mpi_test_projection_small.cc index 3704d52..5b7644b 100644 --- a/tests/mpi_test_projection_small.cc +++ b/tests/mpi_test_projection_small.cc @@ -1,176 +1,176 @@ /** * @file test_projection_small.cc * * @author Till Junge * * @date 16 Jan 2018 * * @brief tests for standard small strain projection operator * * Copyright © 2018 Till Junge * * µSpectre 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, 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 Lesser General Public License * along with µSpectre; see the file COPYING. If not, write to the * Free Software Foundation, Inc., 59 Temple Place - Suite 330, * * Boston, MA 02111-1307, USA. * * Additional permission under GNU GPL version 3 section 7 * * If you modify this Program, or any covered work, by linking or combining it * with proprietary FFT implementations or numerical libraries, containing parts * covered by the terms of those libraries' licenses, the licensors of this * Program grant you additional permission to convey the resulting work. */ #define BOOST_MPL_CFG_NO_PREPROCESSED_HEADERS #define BOOST_MPL_LIMIT_LIST_SIZE 50 #include "fft/projection_small_strain.hh" #include "mpi_test_projection.hh" #include "fft/fft_utils.hh" #include "fft/fftw_engine.hh" #ifdef WITH_FFTWMPI #include "fft/fftwmpi_engine.hh" #endif #ifdef WITH_PFFT #include "fft/pfft_engine.hh" #endif #include namespace muSpectre { BOOST_AUTO_TEST_SUITE(mpi_projection_small_strain); using fixlist = boost::mpl::list< #ifdef WITH_FFTWMPI ProjectionFixture, ProjectionSmallStrain, FFTWMPIEngine>, ProjectionFixture, ProjectionSmallStrain, FFTWMPIEngine>, ProjectionFixture, ProjectionSmallStrain, FFTWMPIEngine>, ProjectionFixture, ProjectionSmallStrain, FFTWMPIEngine>, #endif #ifdef WITH_PFFT ProjectionFixture, ProjectionSmallStrain, PFFTEngine>, ProjectionFixture, ProjectionSmallStrain, PFFTEngine>, ProjectionFixture, ProjectionSmallStrain, PFFTEngine>, ProjectionFixture, ProjectionSmallStrain, PFFTEngine>, #endif ProjectionFixture, ProjectionSmallStrain, FFTWEngine, false>>; /* ---------------------------------------------------------------------- */ BOOST_FIXTURE_TEST_CASE_TEMPLATE(constructor_test, fix, fixlist, fix) { if (fix::is_parallel || fix::projector.get_communicator().size() == 1) { BOOST_CHECK_NO_THROW(fix::projector.initialise(FFT_PlanFlags::estimate)); } } /* ---------------------------------------------------------------------- */ BOOST_FIXTURE_TEST_CASE_TEMPLATE(Gradient_preservation_test, fix, fixlist, fix) { if (!fix::is_parallel || fix::projector.get_communicator().size() > 1) { return; } // create a gradient field with a zero mean gradient and verify // that the projection preserves it constexpr Dim_t dim{fix::sdim}, sdim{fix::sdim}, mdim{fix::mdim}; static_assert( dim == fix::mdim, "These tests assume that the material and spatial dimension are " "identical"); using Fields = GlobalFieldCollection; using FieldT = TensorField; using FieldMap = MatrixFieldMap; using Vector = Eigen::Matrix; Fields fields{}; - FieldT &f_grad{make_field("strain", fields)}; - FieldT &f_var{make_field("working field", fields)}; + FieldT & f_grad{make_field("strain", fields)}; + FieldT & f_var{make_field("working field", fields)}; FieldMap grad(f_grad); FieldMap var(f_var); fields.initialise(fix::projector.get_subdomain_resolutions(), fix::projector.get_subdomain_locations()); Vector k; for (Dim_t i = 0; i < dim; ++i) { // the wave vector has to be such that it leads to an integer // number of periods in each length of the domain k(i) = (i + 1) * 2 * pi / fix::projector.get_domain_lengths()[i]; } - for (auto &&tup : akantu::zip(fields, grad, var)) { - auto &ccoord = std::get<0>(tup); - auto &g = std::get<1>(tup); - auto &v = std::get<2>(tup); + for (auto && tup : akantu::zip(fields, grad, var)) { + auto & ccoord = std::get<0>(tup); + auto & g = std::get<1>(tup); + auto & v = std::get<2>(tup); Vector vec = CcoordOps::get_vector( ccoord, fix::projector.get_domain_lengths() / fix::projector.get_domain_resolutions()); g.row(0) << k.transpose() * cos(k.dot(vec)); // We need to add I to the term, because this field has a net // zero gradient, which leads to a net -I strain g = 0.5 * ((g - g.Identity()).transpose() + (g - g.Identity())).eval() + g.Identity(); v = g; } fix::projector.initialise(FFT_PlanFlags::estimate); fix::projector.apply_projection(f_var); constexpr bool verbose{false}; - for (auto &&tup : akantu::zip(fields, grad, var)) { - auto &ccoord = std::get<0>(tup); - auto &g = std::get<1>(tup); - auto &v = std::get<2>(tup); + for (auto && tup : akantu::zip(fields, grad, var)) { + auto & ccoord = std::get<0>(tup); + auto & g = std::get<1>(tup); + auto & v = std::get<2>(tup); Vector vec = CcoordOps::get_vector( ccoord, fix::projector.get_domain_lengths() / fix::projector.get_domain_resolutions()); Real error = (g - v).norm(); BOOST_CHECK_LT(error, tol); if ((error >= tol) || verbose) { std::cout << std::endl << "grad_ref :" << std::endl << g << std::endl; std::cout << std::endl << "grad_proj :" << std::endl << v << std::endl; std::cout << std::endl << "ccoord :" << std::endl << ccoord << std::endl; std::cout << std::endl << "vector :" << std::endl << vec.transpose() << std::endl; std::cout << "means:" << std::endl << ":" << std::endl << grad.mean() << std::endl << ":" << std::endl << var.mean(); } } } BOOST_AUTO_TEST_SUITE_END(); } // namespace muSpectre diff --git a/tests/mpi_test_solver_newton_cg.cc b/tests/mpi_test_solver_newton_cg.cc index 82adf0d..9d40cff 100644 --- a/tests/mpi_test_solver_newton_cg.cc +++ b/tests/mpi_test_solver_newton_cg.cc @@ -1,224 +1,224 @@ /** * @file test_solver_newton_cg.cc * * @author Till Junge * * @date 20 Dec 2017 * * @brief Tests for the standard Newton-Raphson + Conjugate Gradient solver * * Copyright © 2017 Till Junge * * µSpectre 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, 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 Lesser General Public License * along with µSpectre; see the file COPYING. If not, write to the * Free Software Foundation, Inc., 59 Temple Place - Suite 330, * * Boston, MA 02111-1307, USA. * * Additional permission under GNU GPL version 3 section 7 * * If you modify this Program, or any covered work, by linking or combining it * with proprietary FFT implementations or numerical libraries, containing parts * covered by the terms of those libraries' licenses, the licensors of this * Program grant you additional permission to convey the resulting work. */ #include "tests.hh" #include "mpi_context.hh" #include "solver/deprecated_solvers.hh" #include "solver/deprecated_solver_cg.hh" #include "solver/deprecated_solver_cg_eigen.hh" #include "fft/fftwmpi_engine.hh" #include "fft/projection_finite_strain_fast.hh" #include "materials/material_linear_elastic1.hh" #include "common/iterators.hh" #include "common/ccoord_operations.hh" #include "cell/cell_factory.hh" namespace muSpectre { BOOST_AUTO_TEST_SUITE(newton_cg_tests); BOOST_AUTO_TEST_CASE(manual_construction_test) { - const Communicator &comm = MPIContext::get_context().comm; + const Communicator & comm = MPIContext::get_context().comm; // constexpr Dim_t dim{twoD}; constexpr Dim_t dim{threeD}; // constexpr Ccoord_t resolutions{3, 3}; // constexpr Rcoord_t lengths{2.3, 2.7}; constexpr Ccoord_t resolutions{5, 5, 5}; constexpr Rcoord_t lengths{5, 5, 5}; auto fft_ptr{ std::make_unique>(resolutions, dim * dim, comm)}; auto proj_ptr{std::make_unique>( std::move(fft_ptr), lengths)}; CellBase sys(std::move(proj_ptr)); using Mat_t = MaterialLinearElastic1; // const Real Young{210e9}, Poisson{.33}; const Real Young{1.0030648180242636}, Poisson{0.29930675909878679}; // const Real lambda{Young*Poisson/((1+Poisson)*(1-2*Poisson))}; // const Real mu{Young/(2*(1+Poisson))}; - auto &Material_hard = Mat_t::make(sys, "hard", 10 * Young, Poisson); - auto &Material_soft = Mat_t::make(sys, "soft", Young, Poisson); + auto & Material_hard = Mat_t::make(sys, "hard", 10 * Young, Poisson); + auto & Material_soft = Mat_t::make(sys, "soft", Young, Poisson); - auto &loc = sys.get_subdomain_locations(); - for (auto &&tup : akantu::enumerate(sys)) { - auto &&pixel = std::get<1>(tup); + auto & loc = sys.get_subdomain_locations(); + for (auto && tup : akantu::enumerate(sys)) { + auto && pixel = std::get<1>(tup); if (loc == Ccoord_t{0, 0} && std::get<0>(tup) == 0) { Material_hard.add_pixel(pixel); } else { Material_soft.add_pixel(pixel); } } sys.initialise(); Grad_t delF0; delF0 << 0, 1., 0, 0, 0, 0, 0, 0, 0; constexpr Real cg_tol{1e-8}, newton_tol{1e-5}; constexpr Uint maxiter{CcoordOps::get_size(resolutions) * ipow(dim, secondOrder) * 10}; constexpr bool verbose{false}; GradIncrements grads; grads.push_back(delF0); DeprecatedSolverCG cg{sys, cg_tol, maxiter, static_cast(verbose)}; Eigen::ArrayXXd res1{ deprecated_de_geus(sys, grads, cg, newton_tol, verbose)[0].grad}; DeprecatedSolverCG cg2{sys, cg_tol, maxiter, static_cast(verbose)}; Eigen::ArrayXXd res2{ deprecated_newton_cg(sys, grads, cg2, newton_tol, verbose)[0].grad}; BOOST_CHECK_LE(abs(res1 - res2).mean(), cg_tol); } BOOST_AUTO_TEST_CASE(small_strain_patch_test) { - const Communicator &comm = MPIContext::get_context().comm; + const Communicator & comm = MPIContext::get_context().comm; constexpr Dim_t dim{twoD}; using Ccoord = Ccoord_t; using Rcoord = Rcoord_t; constexpr Ccoord resolutions{CcoordOps::get_cube(3)}; constexpr Rcoord lengths{CcoordOps::get_cube(1.)}; constexpr Formulation form{Formulation::small_strain}; // number of layers in the hard material constexpr Uint nb_lays{1}; constexpr Real contrast{2}; static_assert(nb_lays < resolutions[0], "the number or layers in the hard material must be smaller " "than the total number of layers in dimension 0"); auto sys{make_parallel_cell(resolutions, lengths, form, comm)}; using Mat_t = MaterialLinearElastic1; constexpr Real Young{2.}, Poisson{.33}; auto material_hard{ std::make_unique("hard", contrast * Young, Poisson)}; auto material_soft{std::make_unique("soft", Young, Poisson)}; - for (const auto &pixel : sys) { + for (const auto & pixel : sys) { if (pixel[0] < Dim_t(nb_lays)) { material_hard->add_pixel(pixel); } else { material_soft->add_pixel(pixel); } } sys.add_material(std::move(material_hard)); sys.add_material(std::move(material_soft)); sys.initialise(); Grad_t delEps0{Grad_t::Zero()}; constexpr Real eps0 = 1.; // delEps0(0, 1) = delEps0(1, 0) = eps0; delEps0(0, 0) = eps0; constexpr Real cg_tol{1e-8}, newton_tol{1e-5}, equil_tol{1e-10}; constexpr Uint maxiter{dim * 10}; constexpr Dim_t verbose{0}; DeprecatedSolverCGEigen cg{sys, cg_tol, maxiter, static_cast(verbose)}; auto result = deprecated_de_geus(sys, delEps0, cg, newton_tol, equil_tol, verbose); if (verbose) { std::cout << "result:" << std::endl << result.grad << std::endl; std::cout << "mean strain = " << std::endl << sys.get_strain().get_map().mean() << std::endl; } /** * verification of resultant strains: subscript ₕ for hard and ₛ * for soft, Nₕ is nb_lays and Nₜₒₜ is resolutions, k is contrast * * Δl = εl = Δlₕ + Δlₛ = εₕlₕ+εₛlₛ * => ε = εₕ Nₕ/Nₜₒₜ + εₛ (Nₜₒₜ-Nₕ)/Nₜₒₜ * * σ is constant across all layers * σₕ = σₛ * => Eₕ εₕ = Eₛ εₛ * => εₕ = 1/k εₛ * => ε / (1/k Nₕ/Nₜₒₜ + (Nₜₒₜ-Nₕ)/Nₜₒₜ) = εₛ */ constexpr Real factor{1 / contrast * Real(nb_lays) / resolutions[0] + 1. - nb_lays / Real(resolutions[0])}; constexpr Real eps_soft{eps0 / factor}; constexpr Real eps_hard{eps_soft / contrast}; if (verbose) { std::cout << "εₕ = " << eps_hard << ", εₛ = " << eps_soft << std::endl; std::cout << "ε = εₕ Nₕ/Nₜₒₜ + εₛ (Nₜₒₜ-Nₕ)/Nₜₒₜ" << std::endl; } Grad_t Eps_hard; Eps_hard << eps_hard, 0, 0, 0; Grad_t Eps_soft; Eps_soft << eps_soft, 0, 0, 0; // verify uniaxial tension patch test - for (const auto &pixel : sys) { + for (const auto & pixel : sys) { if (pixel[0] < Dim_t(nb_lays)) { BOOST_CHECK_LE((Eps_hard - sys.get_strain().get_map()[pixel]).norm(), tol); } else { BOOST_CHECK_LE((Eps_soft - sys.get_strain().get_map()[pixel]).norm(), tol); } } delEps0 = Grad_t::Zero(); delEps0(0, 1) = delEps0(1, 0) = eps0; DeprecatedSolverCG cg2{sys, cg_tol, maxiter, static_cast(verbose)}; result = deprecated_newton_cg(sys, delEps0, cg2, newton_tol, equil_tol, verbose); Eps_hard << 0, eps_hard, eps_hard, 0; Eps_soft << 0, eps_soft, eps_soft, 0; // verify pure shear patch test - for (const auto &pixel : sys) { + for (const auto & pixel : sys) { if (pixel[0] < Dim_t(nb_lays)) { BOOST_CHECK_LE((Eps_hard - sys.get_strain().get_map()[pixel]).norm(), tol); } else { BOOST_CHECK_LE((Eps_soft - sys.get_strain().get_map()[pixel]).norm(), tol); } } } BOOST_AUTO_TEST_SUITE_END(); } // namespace muSpectre diff --git a/tests/test_base.cc b/tests/test_base.cc index cf4d9e8..238a9c0 100644 --- a/tests/test_base.cc +++ b/tests/test_base.cc @@ -1,41 +1,39 @@ /** * @file test_base.cc * * @author Till Junge * * @date 01 May 2017 * * @brief Base test (tests only whether the tests compile * * Copyright © 2017 Till Junge * * µSpectre 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, 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 Lesser General Public License * along with µSpectre; see the file COPYING. If not, write to the * Free Software Foundation, Inc., 59 Temple Place - Suite 330, * * Boston, MA 02111-1307, USA. * * Additional permission under GNU GPL version 3 section 7 * * If you modify this Program, or any covered work, by linking or combining it * with proprietary FFT implementations or numerical libraries, containing parts * covered by the terms of those libraries' licenses, the licensors of this * Program grant you additional permission to convey the resulting work. */ #define BOOST_TEST_DYN_LINK #include -BOOST_AUTO_TEST_CASE(base_test) { - BOOST_CHECK_EQUAL(1, 2-1); -} +BOOST_AUTO_TEST_CASE(base_test) { BOOST_CHECK_EQUAL(1, 2 - 1); } diff --git a/tests/test_cell_base.cc b/tests/test_cell_base.cc index ed53bd9..abde920 100644 --- a/tests/test_cell_base.cc +++ b/tests/test_cell_base.cc @@ -1,322 +1,325 @@ /** * @file test_cell_base.cc * * @author Till Junge * * @date 14 Dec 2017 * * @brief Tests for the basic cell class * * Copyright © 2017 Till Junge * * µSpectre 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, 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 Lesser General Public License * along with µSpectre; see the file COPYING. If not, write to the * Free Software Foundation, Inc., 59 Temple Place - Suite 330, * * Boston, MA 02111-1307, USA. * * Additional permission under GNU GPL version 3 section 7 * * If you modify this Program, or any covered work, by linking or combining it * with proprietary FFT implementations or numerical libraries, containing parts * covered by the terms of those libraries' licenses, the licensors of this * Program grant you additional permission to convey the resulting work. */ #include #include #include "tests.hh" #include "common/common.hh" #include "common/iterators.hh" #include "common/field_map.hh" #include "tests/test_goodies.hh" #include "cell/cell_factory.hh" #include "materials/material_linear_elastic1.hh" namespace muSpectre { BOOST_AUTO_TEST_SUITE(cell_base); - template struct Sizes {}; - template <> struct Sizes { + template + struct Sizes {}; + template <> + struct Sizes { constexpr static Dim_t sdim{twoD}; constexpr static Ccoord_t get_resolution() { return Ccoord_t{3, 5}; } constexpr static Rcoord_t get_lengths() { return Rcoord_t{3.4, 5.8}; } }; - template <> struct Sizes { + template <> + struct Sizes { constexpr static Dim_t sdim{threeD}; constexpr static Ccoord_t get_resolution() { return Ccoord_t{3, 5, 7}; } constexpr static Rcoord_t get_lengths() { return Rcoord_t{3.4, 5.8, 6.7}; } }; template struct CellBaseFixture : CellBase { constexpr static Dim_t sdim{DimS}; constexpr static Dim_t mdim{DimM}; constexpr static Formulation formulation{form}; CellBaseFixture() : CellBase{std::move( cell_input(Sizes::get_resolution(), Sizes::get_lengths(), form))} {} }; using fixlist = boost::mpl::list< CellBaseFixture, CellBaseFixture, CellBaseFixture, CellBaseFixture>; BOOST_AUTO_TEST_CASE(manual_construction) { constexpr Dim_t dim{twoD}; Ccoord_t resolutions{3, 3}; Rcoord_t lengths{2.3, 2.7}; Formulation form{Formulation::finite_strain}; auto fft_ptr{std::make_unique>(resolutions, dim * dim)}; auto proj_ptr{std::make_unique>( std::move(fft_ptr), lengths)}; CellBase sys{std::move(proj_ptr)}; auto sys2{make_cell(resolutions, lengths, form)}; auto sys2b{std::move(sys2)}; BOOST_CHECK_EQUAL(sys2b.size(), sys.size()); } BOOST_FIXTURE_TEST_CASE_TEMPLATE(constructor_test, fix, fixlist, fix) { BOOST_CHECK_THROW(fix::check_material_coverage(), std::runtime_error); BOOST_CHECK_THROW(fix::initialise(), std::runtime_error); } BOOST_FIXTURE_TEST_CASE_TEMPLATE(add_material_test, fix, fixlist, fix) { constexpr Dim_t dim{fix::sdim}; using Material_t = MaterialLinearElastic1; auto Material_hard = std::make_unique("hard", 210e9, .33); BOOST_CHECK_NO_THROW(fix::add_material(std::move(Material_hard))); } BOOST_FIXTURE_TEST_CASE_TEMPLATE(simple_evaluation_test, fix, fixlist, fix) { constexpr Dim_t dim{fix::sdim}; constexpr Formulation form{fix::formulation}; using Mat_t = MaterialLinearElastic1; const Real Young{210e9}, Poisson{.33}; const Real lambda{Young * Poisson / ((1 + Poisson) * (1 - 2 * Poisson))}; const Real mu{Young / (2 * (1 + Poisson))}; auto Material_hard = std::make_unique("hard", Young, Poisson); - for (auto &&pixel : *this) { + for (auto && pixel : *this) { Material_hard->add_pixel(pixel); } fix::add_material(std::move(Material_hard)); - auto &F = fix::get_strain(); + auto & F = fix::get_strain(); auto F_map = F.get_map(); // finite strain formulation expects the deformation gradient F, // while small strain expects infinitesimal strain ε for (auto grad : F_map) { switch (form) { case Formulation::finite_strain: { grad = grad.Identity(); break; } case Formulation::small_strain: { grad = grad.Zero(); break; } default: BOOST_CHECK(false); break; } } auto res_tup{fix::evaluate_stress_tangent(F)}; auto stress{std::get<0>(res_tup).get_map()}; auto tangent{std::get<1>(res_tup).get_map()}; auto tup = testGoodies::objective_hooke_explicit(lambda, mu, Matrices::I2()); auto P_ref = std::get<0>(tup); for (auto mat : stress) { Real norm = (mat - P_ref).norm(); BOOST_CHECK_EQUAL(norm, 0.); } auto tan_ref = std::get<1>(tup); for (const auto tan : tangent) { Real norm = (tan - tan_ref).norm(); BOOST_CHECK_EQUAL(norm, 0.); } } BOOST_FIXTURE_TEST_CASE_TEMPLATE(evaluation_test, fix, fixlist, fix) { constexpr Dim_t dim{fix::sdim}; using Mat_t = MaterialLinearElastic1; auto Material_hard = std::make_unique("hard", 210e9, .33); auto Material_soft = std::make_unique("soft", 70e9, .3); - for (auto &&cnt_pixel : akantu::enumerate(*this)) { + for (auto && cnt_pixel : akantu::enumerate(*this)) { auto counter = std::get<0>(cnt_pixel); - auto &&pixel = std::get<1>(cnt_pixel); + auto && pixel = std::get<1>(cnt_pixel); if (counter < 5) { Material_hard->add_pixel(pixel); } else { Material_soft->add_pixel(pixel); } } fix::add_material(std::move(Material_hard)); fix::add_material(std::move(Material_soft)); - auto &F = fix::get_strain(); + auto & F = fix::get_strain(); fix::evaluate_stress_tangent(F); fix::evaluate_stress_tangent(F); } BOOST_FIXTURE_TEST_CASE_TEMPLATE(evaluation_test_new_interface, fix, fixlist, fix) { constexpr Dim_t dim{fix::sdim}; using Mat_t = MaterialLinearElastic1; auto Material_hard = std::make_unique("hard", 210e9, .33); auto Material_soft = std::make_unique("soft", 70e9, .3); - for (auto &&cnt_pixel : akantu::enumerate(*this)) { + for (auto && cnt_pixel : akantu::enumerate(*this)) { auto counter = std::get<0>(cnt_pixel); - auto &&pixel = std::get<1>(cnt_pixel); + auto && pixel = std::get<1>(cnt_pixel); if (counter < 5) { Material_hard->add_pixel(pixel); } else { Material_soft->add_pixel(pixel); } } fix::add_material(std::move(Material_hard)); fix::add_material(std::move(Material_soft)); auto F_vec = fix::get_strain_vector(); F_vec.setZero(); fix::evaluate_stress_tangent(); } BOOST_FIXTURE_TEST_CASE_TEMPLATE(test_managed_fields, Fix, fixlist, Fix) { - Cell &dyn_handle{*this}; - CellBase &base_handle{*this}; + Cell & dyn_handle{*this}; + CellBase & base_handle{*this}; const std::string name1{"aaa"}; constexpr size_t nb_comp{5}; auto new_dyn_array{dyn_handle.get_managed_real_array(name1, nb_comp)}; BOOST_CHECK_EQUAL(new_dyn_array.rows(), nb_comp); BOOST_CHECK_EQUAL(new_dyn_array.cols(), dyn_handle.size()); BOOST_CHECK_THROW(dyn_handle.get_managed_real_array(name1, nb_comp + 1), std::runtime_error); - auto &new_field{base_handle.get_managed_real_field(name1, nb_comp)}; + auto & new_field{base_handle.get_managed_real_field(name1, nb_comp)}; BOOST_CHECK_EQUAL(new_field.get_nb_components(), nb_comp); BOOST_CHECK_EQUAL(new_field.size(), dyn_handle.size()); BOOST_CHECK_THROW(base_handle.get_managed_real_field(name1, nb_comp + 1), std::runtime_error); } BOOST_FIXTURE_TEST_CASE_TEMPLATE(test_globalised_fields, Fix, fixlist, Fix) { constexpr Dim_t Dim{Fix::sdim}; using Mat_t = MaterialLinearElastic1; using LColl_t = typename Mat_t::MFieldCollection_t; - auto &material_soft{Mat_t::make(*this, "soft", 70e9, .3)}; - auto &material_hard{Mat_t::make(*this, "hard", 210e9, .3)}; + auto & material_soft{Mat_t::make(*this, "soft", 70e9, .3)}; + auto & material_hard{Mat_t::make(*this, "hard", 210e9, .3)}; - for (auto &&tup : akantu::enumerate(*this)) { - const auto &i{std::get<0>(tup)}; - const auto &pixel{std::get<1>(tup)}; + for (auto && tup : akantu::enumerate(*this)) { + const auto & i{std::get<0>(tup)}; + const auto & pixel{std::get<1>(tup)}; if (i % 2) { material_soft.add_pixel(pixel); } else { material_hard.add_pixel(pixel); } } material_soft.initialise(); material_hard.initialise(); - auto &col_soft{material_soft.get_collection()}; - auto &col_hard{material_hard.get_collection()}; + auto & col_soft{material_soft.get_collection()}; + auto & col_hard{material_hard.get_collection()}; // compatible fields: const std::string compatible_name{"compatible"}; - auto &compatible_soft{ + auto & compatible_soft{ make_field>(compatible_name, col_soft, Dim)}; - auto &compatible_hard{ + auto & compatible_hard{ make_field>(compatible_name, col_hard, Dim)}; - auto pixler = [](auto &field) { + auto pixler = [](auto & field) { auto map{field.get_map()}; - for (auto &&tup : map.enumerate()) { - const auto &pixel{std::get<0>(tup)}; - auto &val{std::get<1>(tup)}; + for (auto && tup : map.enumerate()) { + const auto & pixel{std::get<0>(tup)}; + auto & val{std::get<1>(tup)}; for (Dim_t i{0}; i < Dim; ++i) { val(i) = pixel[i]; } } }; pixler(compatible_soft); pixler(compatible_hard); - auto &global_compatible_field{ + auto & global_compatible_field{ this->get_globalised_internal_real_field(compatible_name)}; auto glo_map{global_compatible_field.get_map()}; - for (auto &&tup : glo_map.enumerate()) { - const auto &pixel{std::get<0>(tup)}; - const auto &val(std::get<1>(tup)); + for (auto && tup : glo_map.enumerate()) { + const auto & pixel{std::get<0>(tup)}; + const auto & val(std::get<1>(tup)); using Map_t = Eigen::Map>; Real err{ (val - Map_t(pixel.data()).template cast()).matrix().norm()}; BOOST_CHECK_LT(err, tol); } // incompatible fields: const std::string incompatible_name{"incompatible"}; make_field>(incompatible_name, col_soft, Dim); make_field>(incompatible_name, col_hard, Dim + 1); BOOST_CHECK_THROW( this->get_globalised_internal_real_field(incompatible_name), std::runtime_error); // wrong name/ inexistant field const std::string wrong_name{"wrong_name"}; BOOST_CHECK_THROW(this->get_globalised_internal_real_field(wrong_name), std::runtime_error); // wrong scalar type: const std::string wrong_scalar_name{"wrong_scalar"}; make_field>(wrong_scalar_name, col_soft, Dim); make_field>(wrong_scalar_name, col_hard, Dim); BOOST_CHECK_THROW( this->get_globalised_internal_real_field(wrong_scalar_name), std::runtime_error); } BOOST_AUTO_TEST_SUITE_END(); } // namespace muSpectre diff --git a/tests/test_fftw_engine.cc b/tests/test_fftw_engine.cc index 5167108..20a6d7c 100644 --- a/tests/test_fftw_engine.cc +++ b/tests/test_fftw_engine.cc @@ -1,143 +1,144 @@ /** * @file test_fftw_engine.cc * * @author Till Junge * * @date 05 Dec 2017 * * @brief tests for the fftw fft engine implementation * * Copyright © 2017 Till Junge * * µSpectre 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, 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 Lesser General Public License * along with µSpectre; see the file COPYING. If not, write to the * Free Software Foundation, Inc., 59 Temple Place - Suite 330, * * Boston, MA 02111-1307, USA. * * Additional permission under GNU GPL version 3 section 7 * * If you modify this Program, or any covered work, by linking or combining it * with proprietary FFT implementations or numerical libraries, containing parts * covered by the terms of those libraries' licenses, the licensors of this * Program grant you additional permission to convey the resulting work. */ #include #include "tests.hh" #include "fft/fftw_engine.hh" #include "common/ccoord_operations.hh" #include "common/field_collection.hh" #include "common/field_map.hh" #include "common/iterators.hh" namespace muSpectre { BOOST_AUTO_TEST_SUITE(fftw_engine); /* ---------------------------------------------------------------------- */ - template struct FFTW_fixture { + template + struct FFTW_fixture { constexpr static Dim_t box_resolution{resolution}; constexpr static Real box_length{4.5}; constexpr static Dim_t sdim{DimS}; constexpr static Dim_t mdim{DimM}; constexpr static Ccoord_t res() { return CcoordOps::get_cube(box_resolution); } constexpr static Ccoord_t loc() { return CcoordOps::get_cube(0); } FFTW_fixture() : engine(res(), DimM * DimM) {} FFTWEngine engine; }; struct FFTW_fixture_python_segfault { constexpr static Dim_t dim{twoD}; constexpr static Dim_t sdim{twoD}; constexpr static Dim_t mdim{twoD}; constexpr static Ccoord_t res() { return {6, 4}; } constexpr static Ccoord_t loc() { return {0, 0}; } FFTW_fixture_python_segfault() : engine{res(), mdim * mdim} {} FFTWEngine engine; }; using fixlist = boost::mpl::list< FFTW_fixture, FFTW_fixture, FFTW_fixture, FFTW_fixture, FFTW_fixture, FFTW_fixture, FFTW_fixture_python_segfault>; /* ---------------------------------------------------------------------- */ BOOST_FIXTURE_TEST_CASE_TEMPLATE(Constructor_test, Fix, fixlist, Fix) { BOOST_CHECK_NO_THROW(Fix::engine.initialise(FFT_PlanFlags::estimate)); BOOST_CHECK_EQUAL(Fix::engine.size(), CcoordOps::get_size(Fix::res())); } /* ---------------------------------------------------------------------- */ BOOST_FIXTURE_TEST_CASE_TEMPLATE(fft_test, Fix, fixlist, Fix) { Fix::engine.initialise(FFT_PlanFlags::estimate); constexpr Dim_t order{2}; using FC_t = GlobalFieldCollection; FC_t fc; - auto &input{ + auto & input{ make_field>("input", fc)}; - auto &ref{ + auto & ref{ make_field>("reference", fc)}; - auto &result{ + auto & result{ make_field>("result", fc)}; fc.initialise(Fix::res(), Fix::loc()); using map_t = MatrixFieldMap; map_t inmap{input}; auto refmap{map_t{ref}}; auto resultmap{map_t{result}}; size_t cntr{0}; for (auto tup : akantu::zip(inmap, refmap)) { cntr++; - auto &in_{std::get<0>(tup)}; - auto &ref_{std::get<1>(tup)}; + auto & in_{std::get<0>(tup)}; + auto & ref_{std::get<1>(tup)}; in_.setRandom(); ref_ = in_; } - auto &complex_field = Fix::engine.fft(input); + auto & complex_field = Fix::engine.fft(input); using cmap_t = MatrixFieldMap, Complex, Fix::mdim, Fix::mdim>; cmap_t complex_map(complex_field); Real error = complex_map[0].imag().norm(); BOOST_CHECK_LT(error, tol); /* make sure, the engine has not modified input (which is unfortunately const-casted internally, hence this test) */ - for (auto &&tup : akantu::zip(inmap, refmap)) { + for (auto && tup : akantu::zip(inmap, refmap)) { Real error{(std::get<0>(tup) - std::get<1>(tup)).norm()}; BOOST_CHECK_LT(error, tol); } /* make sure that the ifft of fft returns the original*/ Fix::engine.ifft(result); - for (auto &&tup : akantu::zip(resultmap, refmap)) { + for (auto && tup : akantu::zip(resultmap, refmap)) { Real error{ (std::get<0>(tup) * Fix::engine.normalisation() - std::get<1>(tup)) .norm()}; BOOST_CHECK_LT(error, tol); if (error > tol) { std::cout << std::get<0>(tup).array() / std::get<1>(tup).array() << std::endl << std::endl; } } } BOOST_AUTO_TEST_SUITE_END(); } // namespace muSpectre diff --git a/tests/test_field_collections.hh b/tests/test_field_collections.hh index a759537..b238956 100644 --- a/tests/test_field_collections.hh +++ b/tests/test_field_collections.hh @@ -1,159 +1,161 @@ /** * @file test_field_collections.hh * * @author Till Junge * * @date 23 Nov 2017 * * @brief declares fixtures for field_collection tests, so that they can be * split * * Copyright © 2017 Till Junge * * µSpectre 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, 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 Lesser General Public License * along with µSpectre; see the file COPYING. If not, write to the * Free Software Foundation, Inc., 59 Temple Place - Suite 330, * * Boston, MA 02111-1307, USA. * * Additional permission under GNU GPL version 3 section 7 * * If you modify this Program, or any covered work, by linking or combining it * with proprietary FFT implementations or numerical libraries, containing parts * covered by the terms of those libraries' licenses, the licensors of this * Program grant you additional permission to convey the resulting work. */ -#ifndef TESTS_TEST_FIELD_COLLECTIONS_HH_ -#define TESTS_TEST_FIELD_COLLECTIONS_HH_ +#ifndef TESTS_TEST_FIELD_COLLECTIONS_HH_ +#define TESTS_TEST_FIELD_COLLECTIONS_HH_ #include #include #include #include #include #include #include "common/common.hh" #include "common/ccoord_operations.hh" #include "tests/test_goodies.hh" #include "tests.hh" #include "common/field_collection.hh" #include "common/field.hh" #include "common/field_map.hh" namespace muSpectre { //! Test fixture for simple tests on single field in collection template struct FC_fixture : public std::conditional_t, LocalFieldCollection> { FC_fixture() : fc() {} inline static constexpr Dim_t sdim() { return DimS; } inline static constexpr Dim_t mdim() { return DimM; } inline static constexpr bool global() { return Global; } using FC_t = std::conditional_t, LocalFieldCollection>; FC_t fc; }; using test_collections = boost::mpl::list, FC_fixture<2, 3, true>, FC_fixture<3, 3, true>, FC_fixture<2, 2, false>, FC_fixture<2, 3, false>, FC_fixture<3, 3, false>>; constexpr Dim_t order{4}, matrix_order{2}; //! Test fixture for multiple fields in the collection - template struct FC_multi_fixture { + template + struct FC_multi_fixture { using FC_t = std::conditional_t, LocalFieldCollection>; using T4_t = TensorField; using T2_t = TensorField; using Sc_t = ScalarField; using M2_t = MatrixField; using Dyn_t = TypedField; FC_multi_fixture() : fc(), t4_field{make_field("Tensorfield Real o4", fc)}, // Real tensor field t2_field{make_field("Tensorfield Real o2", fc)}, // Real tensor field sc_field{ make_field("integer Scalar", fc)}, // integer scalar field m2_field{make_field("Matrixfield Complex sdim x mdim", fc)}, // complex matrix field dyn_field{make_field("Dynamically sized Field", fc, 12)} {} inline static constexpr Dim_t sdim() { return DimS; } inline static constexpr Dim_t mdim() { return DimM; } inline static constexpr bool global() { return Global; } FC_t fc; - T4_t &t4_field; - T2_t &t2_field; - Sc_t &sc_field; - M2_t &m2_field; - Dyn_t &dyn_field; + T4_t & t4_field; + T2_t & t2_field; + Sc_t & sc_field; + M2_t & m2_field; + Dyn_t & dyn_field; }; using mult_collections = boost::mpl::list< FC_multi_fixture<2, 2, true>, FC_multi_fixture<2, 3, true>, FC_multi_fixture<3, 3, true>, FC_multi_fixture<2, 2, false>, FC_multi_fixture<2, 3, false>, FC_multi_fixture<3, 3, false>>; //! Test fixture for iterators over multiple fields template struct FC_iterator_fixture : public FC_multi_fixture { using Parent = FC_multi_fixture; FC_iterator_fixture() : Parent() { this->fill(); } - template std::enable_if_t fill() { + template + std::enable_if_t fill() { static_assert(Global == isGlobal, "You're breaking my SFINAE plan"); Ccoord_t size; Ccoord_t loc{}; - for (auto &&s : size) { + for (auto && s : size) { s = cube_size(); } this->fc.initialise(size, loc); } template std::enable_if_t fill(int dummy = 0) { static_assert(notGlobal != Global, "You're breaking my SFINAE plan"); testGoodies::RandRange rng; this->fc.add_pixel({0, 0}); for (int i = 0 * dummy; i < sele_size(); ++i) { Ccoord_t pixel; - for (auto &&s : pixel) { + for (auto && s : pixel) { s = rng.randval(0, 7); } this->fc.add_pixel(pixel); } this->fc.initialise(); } constexpr static Dim_t cube_size() { return 3; } constexpr static Dim_t sele_size() { return 7; } }; using iter_collections = boost::mpl::list< FC_iterator_fixture<2, 2, true>, FC_iterator_fixture<2, 3, true>, FC_iterator_fixture<3, 3, true>, FC_iterator_fixture<2, 2, false>, FC_iterator_fixture<2, 3, false>, FC_iterator_fixture<3, 3, false>>; using glob_iter_colls = boost::mpl::list, FC_iterator_fixture<2, 3, true>, FC_iterator_fixture<3, 3, true>>; } // namespace muSpectre #endif // TESTS_TEST_FIELD_COLLECTIONS_HH_ diff --git a/tests/test_goodies.hh b/tests/test_goodies.hh index 06d5933..29815d8 100644 --- a/tests/test_goodies.hh +++ b/tests/test_goodies.hh @@ -1,138 +1,142 @@ /** * @file test_goodies.hh * * @author Till Junge * * @date 27 Sep 2017 * * @brief helpers for testing * * Copyright © 2017 Till Junge * * µSpectre 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, 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 Lesser General Public License * along with µSpectre; see the file COPYING. If not, write to the * Free Software Foundation, Inc., 59 Temple Place - Suite 330, * * Boston, MA 02111-1307, USA. * * Additional permission under GNU GPL version 3 section 7 * * If you modify this Program, or any covered work, by linking or combining it * with proprietary FFT implementations or numerical libraries, containing parts * covered by the terms of those libraries' licenses, the licensors of this * Program grant you additional permission to convey the resulting work. */ #ifndef TESTS_TEST_GOODIES_HH_ #define TESTS_TEST_GOODIES_HH_ #include "common/tensor_algebra.hh" #include #include #include namespace muSpectre { namespace testGoodies { - template struct dimFixture { constexpr static Dim_t dim{Dim}; }; + template + struct dimFixture { + constexpr static Dim_t dim{Dim}; + }; using dimlist = boost::mpl::list, dimFixture, dimFixture>; /* ---------------------------------------------------------------------- */ - template class RandRange { + template + class RandRange { public: RandRange() : rd(), gen(rd()) {} template std::enable_if_t::value, dummyT> - randval(T &&lower, T &&upper) { + randval(T && lower, T && upper) { static_assert(std::is_same::value, "SFINAE"); auto distro = std::uniform_real_distribution(lower, upper); return distro(this->gen); } template std::enable_if_t::value, dummyT> - randval(T &&lower, T &&upper) { + randval(T && lower, T && upper) { static_assert(std::is_same::value, "SFINAE"); auto distro = std::uniform_int_distribution(lower, upper); return distro(this->gen); } private: std::random_device rd; std::default_random_engine gen; }; /** * explicit computation of linearisation of PK1 stress for an * objective Hooke's law. This implementation is not meant to be * efficient, but te reflect exactly the formulation in Curnier * 2000, "Méthodes numériques en mécanique des solides" for * reference and testing */ template decltype(auto) objective_hooke_explicit(Real lambda, Real mu, - const Matrices::Tens2_t &F) { - using Matrices::tensmult; - using Matrices::Tens4_t; + const Matrices::Tens2_t & F) { using Matrices::Tens2_t; + using Matrices::Tens4_t; + using Matrices::tensmult; using T2 = Tens2_t; using T4 = Tens4_t; T2 P; T2 I = P.Identity(); T4 K; // See Curnier, 2000, "Méthodes numériques en mécanique des // solides", p 252, (6.95b) Real Fjrjr = (F.array() * F.array()).sum(); T2 Fjrjm = F.transpose() * F; P.setZero(); for (Dim_t i = 0; i < Dim; ++i) { for (Dim_t m = 0; m < Dim; ++m) { P(i, m) += lambda / 2 * (Fjrjr - Dim) * F(i, m); for (Dim_t r = 0; r < Dim; ++r) { P(i, m) += mu * F(i, r) * (Fjrjm(r, m) - I(r, m)); } } } // See Curnier, 2000, "Méthodes numériques en mécanique des solides", p // 252 Real Fkrkr = (F.array() * F.array()).sum(); T2 Fkmkn = F.transpose() * F; T2 Fisjs = F * F.transpose(); K.setZero(); for (Dim_t i = 0; i < Dim; ++i) { for (Dim_t j = 0; j < Dim; ++j) { for (Dim_t m = 0; m < Dim; ++m) { for (Dim_t n = 0; n < Dim; ++n) { get(K, i, m, j, n) = (lambda * ((Fkrkr - Dim) / 2 * I(i, j) * I(m, n) + F(i, m) * F(j, n)) + mu * (I(i, j) * Fkmkn(m, n) + Fisjs(i, j) * I(m, n) - I(i, j) * I(m, n) + F(i, n) * F(j, m))); } } } } return std::make_tuple(P, K); } } // namespace testGoodies } // namespace muSpectre #endif // TESTS_TEST_GOODIES_HH_ diff --git a/tests/test_material_hyper_elasto_plastic1.cc b/tests/test_material_hyper_elasto_plastic1.cc index 7126bd3..cf11e4b 100644 --- a/tests/test_material_hyper_elasto_plastic1.cc +++ b/tests/test_material_hyper_elasto_plastic1.cc @@ -1,334 +1,335 @@ /** * @file test_material_hyper_elasto_plastic1.cc * * @author Till Junge * * @date 25 Feb 2018 * * @brief Tests for the large-strain Simo-type plastic law implemented * using MaterialMuSpectre * * Copyright © 2018 Till Junge * * µSpectre 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, 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 Lesser General Public License * along with µSpectre; see the file COPYING. If not, write to the * Free Software Foundation, Inc., 59 Temple Place - Suite 330, * * Boston, MA 02111-1307, USA. * * Additional permission under GNU GPL version 3 section 7 * * If you modify this Program, or any covered work, by linking or combining it * with proprietary FFT implementations or numerical libraries, containing parts * covered by the terms of those libraries' licenses, the licensors of this * Program grant you additional permission to convey the resulting work. */ #include "boost/mpl/list.hpp" #include "materials/material_hyper_elasto_plastic1.hh" #include "materials/materials_toolbox.hh" #include "tests.hh" namespace muSpectre { BOOST_AUTO_TEST_SUITE(material_hyper_elasto_plastic_1); - template struct MaterialFixture { + template + struct MaterialFixture { using Mat = Mat_t; constexpr static Real K{.833}; // bulk modulus constexpr static Real mu{.386}; // shear modulus constexpr static Real H{.004}; // hardening modulus constexpr static Real tau_y0{.003}; // initial yield stress constexpr static Real young{MatTB::convert_elastic_modulus< ElasticModulus::Young, ElasticModulus::Bulk, ElasticModulus::Shear>( K, mu)}; constexpr static Real poisson{MatTB::convert_elastic_modulus< ElasticModulus::Poisson, ElasticModulus::Bulk, ElasticModulus::Shear>( K, mu)}; MaterialFixture() : mat("Name", young, poisson, tau_y0, H) {} constexpr static Dim_t sdim{Mat_t::sdim()}; constexpr static Dim_t mdim{Mat_t::mdim()}; Mat_t mat; }; using mats = boost::mpl::list< MaterialFixture>, MaterialFixture>, MaterialFixture>>; BOOST_FIXTURE_TEST_CASE_TEMPLATE(test_constructor, Fix, mats, Fix) { BOOST_CHECK_EQUAL("Name", Fix::mat.get_name()); - auto &mat{Fix::mat}; + auto & mat{Fix::mat}; auto sdim{Fix::sdim}; auto mdim{Fix::mdim}; BOOST_CHECK_EQUAL(sdim, mat.sdim()); BOOST_CHECK_EQUAL(mdim, mat.mdim()); } BOOST_FIXTURE_TEST_CASE_TEMPLATE(test_evaluate_stress, Fix, mats, Fix) { // This test uses precomputed reference values (computed using // elasto-plasticity.py) for the 3d case only // need higher tol because of printout precision of reference solutions constexpr Real hi_tol{1e-8}; constexpr Dim_t mdim{Fix::mdim}, sdim{Fix::sdim}; constexpr bool has_precomputed_values{(mdim == sdim) && (mdim == threeD)}; constexpr bool verbose{false}; using Strain_t = Eigen::Matrix; using traits = MaterialMuSpectre_traits>; using LColl_t = typename traits::LFieldColl_t; using StrainStField_t = StateField>; using FlowStField_t = StateField>; // using StrainStRef_t = typename traits::LStrainMap_t::reference; // using ScalarStRef_t = typename traits::LScalarMap_t::reference; // create statefields LColl_t coll{}; coll.add_pixel({0}); coll.initialise(); - auto &F_{make_statefield("previous gradient", coll)}; - auto &be_{ + auto & F_{make_statefield("previous gradient", coll)}; + auto & be_{ make_statefield("previous elastic strain", coll)}; - auto &eps_{make_statefield("plastic flow", coll)}; + auto & eps_{make_statefield("plastic flow", coll)}; auto F_prev{F_.get_map()}; F_prev[0].current() = Strain_t::Identity(); auto be_prev{be_.get_map()}; be_prev[0].current() = Strain_t::Identity(); auto eps_prev{eps_.get_map()}; eps_prev[0].current() = 0; // elastic deformation Strain_t F{Strain_t::Identity()}; F(0, 1) = 1e-5; F_.cycle(); be_.cycle(); eps_.cycle(); Strain_t stress{ Fix::mat.evaluate_stress(F, F_prev[0], be_prev[0], eps_prev[0])}; if (has_precomputed_values) { Strain_t tau_ref{}; tau_ref << 1.92999522e-11, 3.86000000e-06, 0.00000000e+00, 3.86000000e-06, -1.93000510e-11, 0.00000000e+00, 0.00000000e+00, 0.00000000e+00, -2.95741950e-17; Real error{(tau_ref - stress).norm()}; BOOST_CHECK_LT(error, hi_tol); Strain_t be_ref{}; be_ref << 1.00000000e+00, 1.00000000e-05, 0.00000000e+00, 1.00000000e-05, 1.00000000e+00, 0.00000000e+00, 0.00000000e+00, 0.00000000e+00, 1.00000000e+00; error = (be_ref - be_prev[0].current()).norm(); BOOST_CHECK_LT(error, hi_tol); Real ep_ref{0}; error = ep_ref - eps_prev[0].current(); BOOST_CHECK_LT(error, hi_tol); } if (verbose) { std::cout << "τ =" << std::endl << stress << std::endl; std::cout << "F =" << std::endl << F << std::endl; std::cout << "Fₜ =" << std::endl << F_prev[0].current() << std::endl; std::cout << "bₑ =" << std::endl << be_prev[0].current() << std::endl; std::cout << "εₚ =" << std::endl << eps_prev[0].current() << std::endl; } F_.cycle(); be_.cycle(); eps_.cycle(); // plastic deformation F(0, 1) = .2; stress = Fix::mat.evaluate_stress(F, F_prev[0], be_prev[0], eps_prev[0]); if (has_precomputed_values) { Strain_t tau_ref{}; tau_ref << 1.98151335e-04, 1.98151335e-03, 0.00000000e+00, 1.98151335e-03, -1.98151335e-04, 0.00000000e+00, 0.00000000e+00, 0.00000000e+00, 1.60615155e-16; Real error{(tau_ref - stress).norm()}; BOOST_CHECK_LT(error, hi_tol); Strain_t be_ref{}; be_ref << 1.00052666, 0.00513348, 0., 0.00513348, 0.99949996, 0., 0., 0., 1.; error = (be_ref - be_prev[0].current()).norm(); BOOST_CHECK_LT(error, hi_tol); Real ep_ref{0.11229988}; error = ep_ref - eps_prev[0].current(); BOOST_CHECK_LT(error, hi_tol); } if (verbose) { std::cout << "Post Cycle" << std::endl; std::cout << "τ =" << std::endl << stress << std::endl << "F =" << std::endl << F << std::endl << "Fₜ =" << std::endl << F_prev[0].current() << std::endl << "bₑ =" << std::endl << be_prev[0].current() << std::endl << "εₚ =" << std::endl << eps_prev[0].current() << std::endl; } } BOOST_FIXTURE_TEST_CASE_TEMPLATE(test_evaluate_stiffness, Fix, mats, Fix) { // This test uses precomputed reference values (computed using // elasto-plasticity.py) for the 3d case only // need higher tol because of printout precision of reference solutions constexpr Real hi_tol{1e-8}; constexpr Dim_t mdim{Fix::mdim}, sdim{Fix::sdim}; constexpr bool has_precomputed_values{(mdim == sdim) && (mdim == threeD)}; constexpr bool verbose{has_precomputed_values && false}; using Strain_t = Eigen::Matrix; using Stiffness_t = T4Mat; using traits = MaterialMuSpectre_traits>; using LColl_t = typename traits::LFieldColl_t; using StrainStField_t = StateField>; using FlowStField_t = StateField>; // using StrainStRef_t = typename traits::LStrainMap_t::reference; // using ScalarStRef_t = typename traits::LScalarMap_t::reference; // create statefields LColl_t coll{}; coll.add_pixel({0}); coll.initialise(); - auto &F_{make_statefield("previous gradient", coll)}; - auto &be_{ + auto & F_{make_statefield("previous gradient", coll)}; + auto & be_{ make_statefield("previous elastic strain", coll)}; - auto &eps_{make_statefield("plastic flow", coll)}; + auto & eps_{make_statefield("plastic flow", coll)}; auto F_prev{F_.get_map()}; F_prev[0].current() = Strain_t::Identity(); auto be_prev{be_.get_map()}; be_prev[0].current() = Strain_t::Identity(); auto eps_prev{eps_.get_map()}; eps_prev[0].current() = 0; // elastic deformation Strain_t F{Strain_t::Identity()}; F(0, 1) = 1e-5; F_.cycle(); be_.cycle(); eps_.cycle(); Strain_t stress{}; Stiffness_t stiffness{}; std::tie(stress, stiffness) = Fix::mat.evaluate_stress_tangent(F, F_prev[0], be_prev[0], eps_prev[0]); if (has_precomputed_values) { Strain_t tau_ref{}; tau_ref << 1.92999522e-11, 3.86000000e-06, 0.00000000e+00, 3.86000000e-06, -1.93000510e-11, 0.00000000e+00, 0.00000000e+00, 0.00000000e+00, -2.95741950e-17; Real error{(tau_ref - stress).norm()}; BOOST_CHECK_LT(error, hi_tol); Strain_t be_ref{}; be_ref << 1.00000000e+00, 1.00000000e-05, 0.00000000e+00, 1.00000000e-05, 1.00000000e+00, 0.00000000e+00, 0.00000000e+00, 0.00000000e+00, 1.00000000e+00; error = (be_ref - be_prev[0].current()).norm(); BOOST_CHECK_LT(error, hi_tol); Real ep_ref{0}; error = ep_ref - eps_prev[0].current(); BOOST_CHECK_LT(error, hi_tol); Stiffness_t C4_ref{}; C4_ref << 0.67383333, 0., 0., 0., 0.28783333, 0., 0., 0., 0.28783333, 0., 0.193, 0., 0.193, 0., 0., 0., 0., 0., 0., 0., 0.193, 0., 0., 0., 0.193, 0., 0., 0., 0.193, 0., 0.193, 0., 0., 0., 0., 0., 0.28783333, 0., 0., 0., 0.67383333, 0., 0., 0., 0.28783333, 0., 0., 0., 0., 0., 0.193, 0., 0.193, 0., 0., 0., 0.193, 0., 0., 0., 0.193, 0., 0., 0., 0., 0., 0., 0., 0.193, 0., 0.193, 0., 0.28783333, 0., 0., 0., 0.28783333, 0., 0., 0., 0.67383333; error = (C4_ref - stiffness).norm(); BOOST_CHECK_LT(error, hi_tol); } if (verbose) { std::cout << "C₄ =" << std::endl << stiffness << std::endl; } F_.cycle(); be_.cycle(); eps_.cycle(); // plastic deformation F(0, 1) = .2; std::tie(stress, stiffness) = Fix::mat.evaluate_stress_tangent(F, F_prev[0], be_prev[0], eps_prev[0]); if (has_precomputed_values) { Strain_t tau_ref{}; tau_ref << 1.98151335e-04, 1.98151335e-03, 0.00000000e+00, 1.98151335e-03, -1.98151335e-04, 0.00000000e+00, 0.00000000e+00, 0.00000000e+00, 1.60615155e-16; Real error{(tau_ref - stress).norm()}; BOOST_CHECK_LT(error, hi_tol); Strain_t be_ref{}; be_ref << 1.00052666, 0.00513348, 0., 0.00513348, 0.99949996, 0., 0., 0., 1.; error = (be_ref - be_prev[0].current()).norm(); BOOST_CHECK_LT(error, hi_tol); Real ep_ref{0.11229988}; error = ep_ref - eps_prev[0].current(); BOOST_CHECK_LT(error, hi_tol); Stiffness_t C4_ref{}; C4_ref << +4.23106224e-01, -4.27959704e-04, 0.00000000e+00, -4.27959704e-04, 4.13218286e-01, 0.00000000e+00, 0.00000000e+00, 0.00000000e+00, 4.13175490e-01, -4.27959704e-04, 7.07167743e-04, 0.00000000e+00, 7.07167743e-04, 4.27959704e-04, 0.00000000e+00, 0.00000000e+00, 0.00000000e+00, 2.79121029e-18, +0.00000000e+00, 0.00000000e+00, 4.98676478e-03, 0.00000000e+00, 0.00000000e+00, 0.00000000e+00, 4.98676478e-03, 0.00000000e+00, 0.00000000e+00, -4.27959704e-04, 7.07167743e-04, 0.00000000e+00, 7.07167743e-04, 4.27959704e-04, 0.00000000e+00, 0.00000000e+00, 0.00000000e+00, 2.79121029e-18, +4.13218286e-01, 4.27959704e-04, 0.00000000e+00, 4.27959704e-04, 4.23106224e-01, 0.00000000e+00, 0.00000000e+00, 0.00000000e+00, 4.13175490e-01, +0.00000000e+00, 0.00000000e+00, 0.00000000e+00, 0.00000000e+00, 0.00000000e+00, 4.98676478e-03, 0.00000000e+00, 4.98676478e-03, 0.00000000e+00, +0.00000000e+00, 0.00000000e+00, 4.98676478e-03, 0.00000000e+00, 0.00000000e+00, 0.00000000e+00, 4.98676478e-03, 0.00000000e+00, 0.00000000e+00, +0.00000000e+00, 0.00000000e+00, 0.00000000e+00, 0.00000000e+00, 0.00000000e+00, 4.98676478e-03, 0.00000000e+00, 4.98676478e-03, 0.00000000e+00, +4.13175490e-01, 2.79121029e-18, 0.00000000e+00, 2.79121029e-18, 4.13175490e-01, 0.00000000e+00, 0.00000000e+00, 0.00000000e+00, 4.23149020e-01; error = (C4_ref - stiffness).norm(); BOOST_CHECK_LT(error, hi_tol); } if (verbose) { std::cout << "Post Cycle" << std::endl; std::cout << "C₄ =" << std::endl << stiffness << std::endl; } } BOOST_AUTO_TEST_SUITE_END(); } // namespace muSpectre diff --git a/tests/test_material_linear_elastic1.cc b/tests/test_material_linear_elastic1.cc index 74877f3..ed36e30 100644 --- a/tests/test_material_linear_elastic1.cc +++ b/tests/test_material_linear_elastic1.cc @@ -1,233 +1,235 @@ /** * @file test_material_linear_elastic1.cc * * @author Till Junge * * @date 28 Nov 2017 * * @brief Tests for the large-strain, objective Hooke's law, implemented in * the convenient strategy (i.e., using MaterialMuSpectre), also used * to test parts of MaterialLinearElastic2 * * Copyright © 2017 Till Junge * * µSpectre 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, 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 Lesser General Public License * along with µSpectre; see the file COPYING. If not, write to the * Free Software Foundation, Inc., 59 Temple Place - Suite 330, * * Boston, MA 02111-1307, USA. * * Additional permission under GNU GPL version 3 section 7 * * If you modify this Program, or any covered work, by linking or combining it * with proprietary FFT implementations or numerical libraries, containing parts * covered by the terms of those libraries' licenses, the licensors of this * Program grant you additional permission to convey the resulting work. */ #include #include #include #include "materials/material_linear_elastic1.hh" #include "materials/material_linear_elastic2.hh" #include "tests.hh" #include "tests/test_goodies.hh" #include "common/field_collection.hh" #include "common/iterators.hh" namespace muSpectre { BOOST_AUTO_TEST_SUITE(material_linear_elastic_1); - template struct MaterialFixture { + template + struct MaterialFixture { using Mat = Mat_t; constexpr static Real lambda{2}, mu{1.5}; constexpr static Real young{mu * (3 * lambda + 2 * mu) / (lambda + mu)}; constexpr static Real poisson{lambda / (2 * (lambda + mu))}; MaterialFixture() : mat("Name", young, poisson) {} constexpr static Dim_t sdim{Mat_t::sdim()}; constexpr static Dim_t mdim{Mat_t::mdim()}; Mat_t mat; }; - template struct has_internals { + template + struct has_internals { constexpr static bool value{false}; }; template struct has_internals> { constexpr static bool value{true}; }; using mat_list = boost::mpl::list>, MaterialFixture>, MaterialFixture>, MaterialFixture>, MaterialFixture>, MaterialFixture>>; BOOST_FIXTURE_TEST_CASE_TEMPLATE(test_constructor, Fix, mat_list, Fix) { BOOST_CHECK_EQUAL("Name", Fix::mat.get_name()); - auto &mat{Fix::mat}; + auto & mat{Fix::mat}; auto sdim{Fix::sdim}; auto mdim{Fix::mdim}; BOOST_CHECK_EQUAL(sdim, mat.sdim()); BOOST_CHECK_EQUAL(mdim, mat.mdim()); } BOOST_FIXTURE_TEST_CASE_TEMPLATE(test_add_pixel, Fix, mat_list, Fix) { - auto &mat{Fix::mat}; + auto & mat{Fix::mat}; constexpr Dim_t sdim{Fix::sdim}; testGoodies::RandRange rng; const Dim_t nb_pixel{7}, box_size{17}; using Ccoord = Ccoord_t; for (Dim_t i = 0; i < nb_pixel; ++i) { Ccoord c; for (Dim_t j = 0; j < sdim; ++j) { c[j] = rng.randval(0, box_size); } if (!has_internals::value) { BOOST_CHECK_NO_THROW(mat.add_pixel(c)); } } BOOST_CHECK_NO_THROW(mat.initialise()); } template struct MaterialFixtureFilled : public MaterialFixture { using Mat = Mat_t; constexpr static Dim_t box_size{3}; MaterialFixtureFilled() : MaterialFixture() { using Ccoord = Ccoord_t; Ccoord cube{CcoordOps::get_cube(box_size)}; CcoordOps::Pixels pixels(cube); for (auto pixel : pixels) { this->mat.add_pixel(pixel); } this->mat.initialise(); } }; using mat_fill = boost::mpl::list< MaterialFixtureFilled>, MaterialFixtureFilled>, MaterialFixtureFilled>>; BOOST_FIXTURE_TEST_CASE_TEMPLATE(test_evaluate_law, Fix, mat_fill, Fix) { constexpr auto cube{CcoordOps::get_cube(Fix::box_size)}; constexpr auto loc{CcoordOps::get_cube(0)}; - auto &mat{Fix::mat}; + auto & mat{Fix::mat}; using FC_t = GlobalFieldCollection; FC_t globalfields; - auto &F{make_field( + auto & F{make_field( "Transformation Gradient", globalfields)}; - auto &P1 = make_field( + auto & P1 = make_field( "Nominal Stress1", globalfields); // to be computed alone - auto &P2 = make_field( + auto & P2 = make_field( "Nominal Stress2", globalfields); // to be computed with tangent - auto &K = make_field( + auto & K = make_field( "Tangent Moduli", globalfields); // to be computed with tangent - auto &Pr = make_field( + auto & Pr = make_field( "Nominal Stress reference", globalfields); - auto &Kr = make_field( + auto & Kr = make_field( "Tangent Moduli reference", globalfields); // to be computed with tangent globalfields.initialise(cube, loc); static_assert( std::is_same::value, "oh oh"); static_assert( std::is_same::value, "oh oh"); static_assert(std::is_same::value, "oh oh"); static_assert( std::is_same::value, "oh oh"); static_assert(std::is_same::value, "oh oh"); static_assert(std::is_same::value, "oh oh"); using traits = MaterialMuSpectre_traits; { // block to contain not-constant gradient map typename traits::StressMap_t grad_map( globalfields["Transformation Gradient"]); for (auto F_ : grad_map) { F_.setRandom(); } grad_map[0] = grad_map[0].Identity(); // identifiable gradients for debug grad_map[1] = 1.2 * grad_map[1].Identity(); // ditto } // compute stresses using material mat.compute_stresses(globalfields["Transformation Gradient"], globalfields["Nominal Stress1"], Formulation::finite_strain); // compute stresses and tangent moduli using material BOOST_CHECK_THROW( mat.compute_stresses_tangent(globalfields["Transformation Gradient"], globalfields["Nominal Stress2"], globalfields["Nominal Stress2"], Formulation::finite_strain), std::runtime_error); mat.compute_stresses_tangent(globalfields["Transformation Gradient"], globalfields["Nominal Stress2"], globalfields["Tangent Moduli"], Formulation::finite_strain); typename traits::StrainMap_t Fmap(globalfields["Transformation Gradient"]); typename traits::StressMap_t Pmap_ref( globalfields["Nominal Stress reference"]); typename traits::TangentMap_t Kmap_ref( globalfields["Tangent Moduli reference"]); for (auto tup : akantu::zip(Fmap, Pmap_ref, Kmap_ref)) { auto F_ = std::get<0>(tup); auto P_ = std::get<1>(tup); auto K_ = std::get<2>(tup); std::tie(P_, K_) = testGoodies::objective_hooke_explicit( Fix::lambda, Fix::mu, F_); } typename traits::StressMap_t Pmap_1(globalfields["Nominal Stress1"]); for (auto tup : akantu::zip(Pmap_ref, Pmap_1)) { auto P_r = std::get<0>(tup); auto P_1 = std::get<1>(tup); Real error = (P_r - P_1).norm(); BOOST_CHECK_LT(error, tol); } typename traits::StressMap_t Pmap_2(globalfields["Nominal Stress2"]); typename traits::TangentMap_t Kmap(globalfields["Tangent Moduli"]); for (auto tup : akantu::zip(Pmap_ref, Pmap_2, Kmap_ref, Kmap)) { auto P_r = std::get<0>(tup); auto P = std::get<1>(tup); Real error = (P_r - P).norm(); BOOST_CHECK_LT(error, tol); auto K_r = std::get<2>(tup); auto K = std::get<3>(tup); error = (K_r - K).norm(); BOOST_CHECK_LT(error, tol); } } BOOST_AUTO_TEST_SUITE_END(); } // namespace muSpectre diff --git a/tests/test_material_linear_elastic2.cc b/tests/test_material_linear_elastic2.cc index 26557d2..56222ab 100644 --- a/tests/test_material_linear_elastic2.cc +++ b/tests/test_material_linear_elastic2.cc @@ -1,279 +1,280 @@ /** * @file test_material_linear_elastic2.cc * * @author Till Junge * * @date 04 Feb 2018 * * @brief Tests for the objective Hooke's law with eigenstrains, * (tests that do not require add_pixel are integrated into * `test_material_linear_elastic1.cc` * * @section LICENSE * * Copyright © 2018 Till Junge * * µSpectre 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, 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 Lesser General Public License * along with µSpectre; see the file COPYING. If not, write to the * Free Software Foundation, Inc., 59 Temple Place - Suite 330, * * Boston, MA 02111-1307, USA. * * Additional permission under GNU GPL version 3 section 7 * * If you modify this Program, or any covered work, by linking or combining it * with proprietary FFT implementations or numerical libraries, containing parts * covered by the terms of those libraries' licenses, the licensors of this * Program grant you additional permission to convey the resulting work. */ #include #include #include #include "materials/material_linear_elastic2.hh" #include "tests.hh" #include "tests/test_goodies.hh" #include "common/field_collection.hh" #include "common/iterators.hh" namespace muSpectre { BOOST_AUTO_TEST_SUITE(material_linear_elastic_2); - template struct MaterialFixture { + template + struct MaterialFixture { using Mat = Mat_t; constexpr static Real lambda{2}, mu{1.5}; constexpr static Real young{mu * (3 * lambda + 2 * mu) / (lambda + mu)}; constexpr static Real poisson{lambda / (2 * (lambda + mu))}; MaterialFixture() : mat("Name", young, poisson) {} constexpr static Dim_t sdim{Mat_t::sdim()}; constexpr static Dim_t mdim{Mat_t::mdim()}; Mat_t mat; }; using mat_list = boost::mpl::list>, MaterialFixture>, MaterialFixture>>; BOOST_FIXTURE_TEST_CASE_TEMPLATE(test_constructor, Fix, mat_list, Fix) { BOOST_CHECK_EQUAL("Name", Fix::mat.get_name()); - auto &mat{Fix::mat}; + auto & mat{Fix::mat}; auto sdim{Fix::sdim}; auto mdim{Fix::mdim}; BOOST_CHECK_EQUAL(sdim, mat.sdim()); BOOST_CHECK_EQUAL(mdim, mat.mdim()); } BOOST_FIXTURE_TEST_CASE_TEMPLATE(test_add_pixel, Fix, mat_list, Fix) { - auto &mat{Fix::mat}; + auto & mat{Fix::mat}; constexpr Dim_t sdim{Fix::sdim}; testGoodies::RandRange rng; const Dim_t nb_pixel{7}, box_size{17}; using Ccoord = Ccoord_t; for (Dim_t i = 0; i < nb_pixel; ++i) { Ccoord c; for (Dim_t j = 0; j < sdim; ++j) { c[j] = rng.randval(0, box_size); } Eigen::Matrix Zero = Eigen::Matrix::Zero(); BOOST_CHECK_NO_THROW(mat.add_pixel(c, Zero)); } BOOST_CHECK_NO_THROW(mat.initialise()); } BOOST_FIXTURE_TEST_CASE_TEMPLATE(test_eigenstrain_equivalence, Fix, mat_list, Fix) { - auto &mat{Fix::mat}; + auto & mat{Fix::mat}; const Dim_t nb_pixel{2}; constexpr auto cube{CcoordOps::get_cube(nb_pixel)}; constexpr auto loc{CcoordOps::get_cube(0)}; using Mat_t = Eigen::Matrix; using FC_t = GlobalFieldCollection; FC_t globalfields; - auto &F_f{make_field( + auto & F_f{make_field( "Transformation Gradient", globalfields)}; - auto &P1_f = make_field( + auto & P1_f = make_field( "Nominal Stress1", globalfields); // to be computed alone - auto &K_f = make_field( + auto & K_f = make_field( "Tangent Moduli", globalfields); // to be computed with tangent globalfields.initialise(cube, loc); Mat_t zero{Mat_t::Zero()}; Mat_t F{Mat_t::Random() / 100 + Mat_t::Identity()}; Mat_t strain{-.5 * (F + F.transpose()) - Mat_t::Identity()}; using Ccoord = Ccoord_t; Ccoord pix0{0}; Ccoord pix1{1}; mat.add_pixel(pix0, zero); mat.add_pixel(pix1, strain); mat.initialise(); F_f.get_map()[pix0] = -strain; F_f.get_map()[pix1] = zero; mat.compute_stresses_tangent(F_f, P1_f, K_f, Formulation::small_strain); Real error{(P1_f.get_map()[pix0] - P1_f.get_map()[pix1]).norm()}; Real tol{1e-12}; if (error >= tol) { std::cout << "error = " << error << " >= " << tol << " = tol" << std::endl; std::cout << "P(0) =" << std::endl << P1_f.get_map()[pix0] << std::endl; std::cout << "P(1) =" << std::endl << P1_f.get_map()[pix1] << std::endl; } BOOST_CHECK_LT(error, tol); } template struct MaterialFixtureFilled : public MaterialFixture { using Par = MaterialFixture; using Mat = Mat_t; constexpr static Dim_t box_size{3}; MaterialFixtureFilled() : MaterialFixture() { using Ccoord = Ccoord_t; Ccoord cube{CcoordOps::get_cube(box_size)}; CcoordOps::Pixels pixels(cube); for (auto pixel : pixels) { Eigen::Matrix Zero = Eigen::Matrix::Zero(); this->mat.add_pixel(pixel, Zero); } this->mat.initialise(); } }; using mat_fill = boost::mpl::list< MaterialFixtureFilled>, MaterialFixtureFilled>, MaterialFixtureFilled>>; BOOST_FIXTURE_TEST_CASE_TEMPLATE(test_evaluate_law, Fix, mat_fill, Fix) { constexpr auto cube{CcoordOps::get_cube(Fix::box_size)}; constexpr auto loc{CcoordOps::get_cube(0)}; - auto &mat{Fix::mat}; + auto & mat{Fix::mat}; using FC_t = GlobalFieldCollection; FC_t globalfields; - auto &F{make_field( + auto & F{make_field( "Transformation Gradient", globalfields)}; - auto &P1 = make_field( + auto & P1 = make_field( "Nominal Stress1", globalfields); // to be computed alone - auto &P2 = make_field( + auto & P2 = make_field( "Nominal Stress2", globalfields); // to be computed with tangent - auto &K = make_field( + auto & K = make_field( "Tangent Moduli", globalfields); // to be computed with tangent - auto &Pr = make_field( + auto & Pr = make_field( "Nominal Stress reference", globalfields); - auto &Kr = make_field( + auto & Kr = make_field( "Tangent Moduli reference", globalfields); // to be computed with tangent globalfields.initialise(cube, loc); static_assert( std::is_same::value, "oh oh"); static_assert( std::is_same::value, "oh oh"); static_assert(std::is_same::value, "oh oh"); static_assert( std::is_same::value, "oh oh"); static_assert(std::is_same::value, "oh oh"); static_assert(std::is_same::value, "oh oh"); using traits = MaterialMuSpectre_traits; { // block to contain not-constant gradient map typename traits::StressMap_t grad_map( globalfields["Transformation Gradient"]); for (auto F_ : grad_map) { F_.setRandom(); } grad_map[0] = grad_map[0].Identity(); // identifiable gradients for debug grad_map[1] = 1.2 * grad_map[1].Identity(); // ditto } // compute stresses using material mat.compute_stresses(globalfields["Transformation Gradient"], globalfields["Nominal Stress1"], Formulation::finite_strain); // compute stresses and tangent moduli using material BOOST_CHECK_THROW( mat.compute_stresses_tangent(globalfields["Transformation Gradient"], globalfields["Nominal Stress2"], globalfields["Nominal Stress2"], Formulation::finite_strain), std::runtime_error); mat.compute_stresses_tangent(globalfields["Transformation Gradient"], globalfields["Nominal Stress2"], globalfields["Tangent Moduli"], Formulation::finite_strain); typename traits::StrainMap_t Fmap(globalfields["Transformation Gradient"]); typename traits::StressMap_t Pmap_ref( globalfields["Nominal Stress reference"]); typename traits::TangentMap_t Kmap_ref( globalfields["Tangent Moduli reference"]); for (auto tup : akantu::zip(Fmap, Pmap_ref, Kmap_ref)) { auto F_ = std::get<0>(tup); auto P_ = std::get<1>(tup); auto K_ = std::get<2>(tup); std::tie(P_, K_) = testGoodies::objective_hooke_explicit( Fix::lambda, Fix::mu, F_); } typename traits::StressMap_t Pmap_1(globalfields["Nominal Stress1"]); for (auto tup : akantu::zip(Pmap_ref, Pmap_1)) { auto P_r = std::get<0>(tup); auto P_1 = std::get<1>(tup); Real error = (P_r - P_1).norm(); BOOST_CHECK_LT(error, tol); } typename traits::StressMap_t Pmap_2(globalfields["Nominal Stress2"]); typename traits::TangentMap_t Kmap(globalfields["Tangent Moduli"]); for (auto tup : akantu::zip(Pmap_ref, Pmap_2, Kmap_ref, Kmap)) { auto P_r = std::get<0>(tup); auto P = std::get<1>(tup); Real error = (P_r - P).norm(); if (error >= tol) { std::cout << "error = " << error << " >= " << tol << " = tol" << std::endl; std::cout << "P(0) =" << std::endl << P_r << std::endl; std::cout << "P(1) =" << std::endl << P << std::endl; } BOOST_CHECK_LT(error, tol); auto K_r = std::get<2>(tup); auto K = std::get<3>(tup); error = (K_r - K).norm(); BOOST_CHECK_LT(error, tol); } } BOOST_AUTO_TEST_SUITE_END(); } // namespace muSpectre diff --git a/tests/test_material_linear_elastic3.cc b/tests/test_material_linear_elastic3.cc index e689245..a25b0c8 100644 --- a/tests/test_material_linear_elastic3.cc +++ b/tests/test_material_linear_elastic3.cc @@ -1,92 +1,92 @@ /** * @file test_material_linear_elastic3.cc * * @author Richard Leute * * @date 21 Feb 2018 * * @brief description * * Copyright © 2018 Till Junge * * µSpectre 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, 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 Lesser General Public License * along with µSpectre; see the file COPYING. If not, write to the * Free Software Foundation, Inc., 59 Temple Place - Suite 330, * * Boston, MA 02111-1307, USA. * * Additional permission under GNU GPL version 3 section 7 * * If you modify this Program, or any covered work, by linking or combining it * with proprietary FFT implementations or numerical libraries, containing parts * covered by the terms of those libraries' licenses, the licensors of this * Program grant you additional permission to convey the resulting work. */ #include #include "tests.hh" #include "materials/material_linear_elastic3.hh" #include "materials/materials_toolbox.hh" #include "common/T4_map_proxy.hh" #include "cmath" namespace muSpectre { BOOST_AUTO_TEST_SUITE(material_linear_elastic_3); - template struct MaterialFixture { + template + struct MaterialFixture { using Material_t = Mat_t; Material_t mat; MaterialFixture() : mat("name") { mat.add_pixel({0}, Young, Poisson); } Real Young{10}; Real Poisson{0.3}; }; using mat_list = boost::mpl::list>, MaterialFixture>, MaterialFixture>>; - BOOST_FIXTURE_TEST_CASE_TEMPLATE(test_constructor, Fix, mat_list, Fix){ - }; + BOOST_FIXTURE_TEST_CASE_TEMPLATE(test_constructor, Fix, mat_list, Fix){}; BOOST_FIXTURE_TEST_CASE_TEMPLATE(test_response, Fix, mat_list, Fix) { constexpr Dim_t Dim{Fix::Material_t::Parent::Parent::mdim()}; Eigen::Matrix E; E.setZero(); E(0, 0) = 0.001; E(1, 0) = E(0, 1) = 0.005; using Hooke = MatTB::Hooke, T4Mat>; Real lambda = Hooke::compute_lambda(Fix::Young, Fix::Poisson); Real mu = Hooke::compute_mu(Fix::Young, Fix::Poisson); auto C = Hooke::compute_C(lambda, mu); T4MatMap Cmap{C.data()}; Eigen::Matrix stress = Fix::mat.evaluate_stress(E, Cmap); Real sigma00 = lambda * E(0, 0) + 2 * mu * E(0, 0); Real sigma01 = 2 * mu * E(0, 1); Real sigma11 = lambda * E(0, 0); BOOST_CHECK_LT(std::abs(stress(0, 0) - sigma00), tol); BOOST_CHECK_LT(std::abs(stress(0, 1) - sigma01), tol); BOOST_CHECK_LT(std::abs(stress(1, 0) - sigma01), tol); BOOST_CHECK_LT(std::abs(stress(1, 1) - sigma11), tol); if (Dim == threeD) { for (int i = 0; i < Dim - 1; ++i) { BOOST_CHECK_LT(std::abs(stress(2, i)), tol); BOOST_CHECK_LT(std::abs(stress(i, 2)), tol); } BOOST_CHECK_LT(std::abs(stress(2, 2) - sigma11), tol); } }; BOOST_AUTO_TEST_SUITE_END(); } // namespace muSpectre diff --git a/tests/test_material_linear_elastic4.cc b/tests/test_material_linear_elastic4.cc index 3e7a387..5677597 100644 --- a/tests/test_material_linear_elastic4.cc +++ b/tests/test_material_linear_elastic4.cc @@ -1,97 +1,97 @@ /** * @file test_material_linear_elastic4.cc * * @author Richard Leute * * @date 27 Mar 2018 * * @brief description * * Copyright © 2018 Richard Leute * * µSpectre 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, 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 Lesser General Public License * along with µSpectre; see the file COPYING. If not, write to the * Free Software Foundation, Inc., 59 Temple Place - Suite 330, * * Boston, MA 02111-1307, USA. * * Additional permission under GNU GPL version 3 section 7 * * If you modify this Program, or any covered work, by linking or combining it * with proprietary FFT implementations or numerical libraries, containing parts * covered by the terms of those libraries' licenses, the licensors of this * Program grant you additional permission to convey the resulting work. */ #include #include "tests.hh" #include "materials/material_linear_elastic4.hh" #include "materials/materials_toolbox.hh" #include "common/T4_map_proxy.hh" #include "cmath" namespace muSpectre { BOOST_AUTO_TEST_SUITE(material_linear_elastic_4); - template struct MaterialFixture { + template + struct MaterialFixture { using Material_t = Mat_t; Material_t mat; MaterialFixture() : mat("name") { mat.add_pixel({0}, Youngs_modulus, Poisson_ratio); } Real Youngs_modulus{10}; Real Poisson_ratio{0.3}; }; using mat_list = boost::mpl::list>, MaterialFixture>, MaterialFixture>>; - BOOST_FIXTURE_TEST_CASE_TEMPLATE(test_constructor, Fix, mat_list, Fix){ - }; + BOOST_FIXTURE_TEST_CASE_TEMPLATE(test_constructor, Fix, mat_list, Fix){}; BOOST_FIXTURE_TEST_CASE_TEMPLATE(test_response, Fix, mat_list, Fix) { constexpr Dim_t Dim{Fix::Material_t::Parent::Parent::mdim()}; Eigen::Matrix E; E.setZero(); E(0, 0) = 0.001; E(1, 0) = E(0, 1) = 0.005; using Hooke = MatTB::Hooke, T4Mat>; Real lambda = Hooke::compute_lambda(Fix::Youngs_modulus, Fix::Poisson_ratio); Real mu = Hooke::compute_mu(Fix::Youngs_modulus, Fix::Poisson_ratio); Eigen::Matrix stress = Fix::mat.evaluate_stress(E, lambda, mu); Real sigma00 = lambda * E(0, 0) + 2 * mu * E(0, 0); Real sigma01 = 2 * mu * E(0, 1); Real sigma11 = lambda * E(0, 0); BOOST_CHECK_LT(std::abs(stress(0, 0) - sigma00), tol); BOOST_CHECK_LT(std::abs(stress(0, 1) - sigma01), tol); BOOST_CHECK_LT(std::abs(stress(1, 0) - sigma01), tol); BOOST_CHECK_LT(std::abs(stress(1, 1) - sigma11), tol); if (Dim == threeD) { for (int i = 0; i < Dim - 1; ++i) { BOOST_CHECK_LT(std::abs(stress(2, i)), tol); BOOST_CHECK_LT(std::abs(stress(i, 2)), tol); } BOOST_CHECK_LT(std::abs(stress(2, 2) - sigma11), tol); } }; BOOST_AUTO_TEST_SUITE_END(); } // namespace muSpectre diff --git a/tests/test_material_linear_elastic_generic.cc b/tests/test_material_linear_elastic_generic.cc index 42b45cb..b7d6014 100644 --- a/tests/test_material_linear_elastic_generic.cc +++ b/tests/test_material_linear_elastic_generic.cc @@ -1,92 +1,93 @@ /** * @file test_material_linear_elastic_generic.cc * * @author Till Junge * * @date 21 Sep 2018 * * @brief test for the generic linear elastic law * * Copyright © 2018 Till Junge * * µSpectre 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, 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 Lesser General Public License * along with µSpectre; see the file COPYING. If not, write to the * Free Software Foundation, Inc., 59 Temple Place - Suite 330, * * Boston, MA 02111-1307, USA. * * Additional permission under GNU GPL version 3 section 7 * * If you modify this Program, or any covered work, by linking or combining it * with proprietary FFT implementations or numerical libraries, containing parts * covered by the terms of those libraries' licenses, the licensors of this * Program grant you additional permission to convey the resulting work. */ #include "tests.hh" #include "materials/material_linear_elastic_generic.cc" #include "materials/materials_toolbox.hh" #include namespace muSpectre { BOOST_AUTO_TEST_SUITE(material_linear_elastic_generic); - template struct MatFixture { + template + struct MatFixture { using Mat_t = MaterialLinearElasticGeneric; using T2_t = Eigen::Matrix; using T4_t = T4Mat; using V_t = Eigen::Matrix; constexpr static Real lambda{2}, mu{1.5}; constexpr static Real get_lambda() { return lambda; } constexpr static Real get_mu() { return mu; } constexpr static Real young{mu * (3 * lambda + 2 * mu) / (lambda + mu)}; constexpr static Real poisson{lambda / (2 * (lambda + mu))}; using Hooke = MatTB::Hooke; MatFixture() : C_voigt{get_C_voigt()}, mat("material", this->C_voigt) {} static V_t get_C_voigt() { V_t C{}; C.setZero(); C.template topLeftCorner().setConstant(get_lambda()); C.template topLeftCorner() += 2 * get_mu() * T2_t::Identity(); constexpr Dim_t Rest{vsize(Dim) - Dim}; using Rest_t = Eigen::Matrix; C.template bottomRightCorner() += get_mu() * Rest_t::Identity(); return C; } V_t C_voigt; Mat_t mat; }; using mats = boost::mpl::list, MatFixture>; BOOST_FIXTURE_TEST_CASE_TEMPLATE(C_test, Fix, mats, Fix) { const auto ref_C{ Fix::Hooke::compute_C_T4(Fix::get_lambda(), Fix::get_mu())}; Real error{(ref_C - Fix::mat.get_C()).norm()}; BOOST_CHECK_LT(error, tol); if (not(error < tol)) { std::cout << "ref:" << std::endl << ref_C << std::endl; std::cout << "new:" << std::endl << Fix::mat.get_C() << std::endl; } } BOOST_AUTO_TEST_SUITE_END(); } // namespace muSpectre diff --git a/tests/test_materials_toolbox.cc b/tests/test_materials_toolbox.cc index c456f3a..9c030a8 100644 --- a/tests/test_materials_toolbox.cc +++ b/tests/test_materials_toolbox.cc @@ -1,279 +1,279 @@ /** * @file test_materials_toolbox.cc * * @author Till Junge * * @date 05 Nov 2017 * * @brief Tests for the materials toolbox * * Copyright © 2017 Till Junge * * µSpectre 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, 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 Lesser General Public License * along with µSpectre; see the file COPYING. If not, write to the * Free Software Foundation, Inc., 59 Temple Place - Suite 330, * * Boston, MA 02111-1307, USA. * * Additional permission under GNU GPL version 3 section 7 * * If you modify this Program, or any covered work, by linking or combining it * with proprietary FFT implementations or numerical libraries, containing parts * covered by the terms of those libraries' licenses, the licensors of this * Program grant you additional permission to convey the resulting work. */ #include #include "tests.hh" #include "materials/materials_toolbox.hh" #include "common/T4_map_proxy.hh" #include "common/tensor_algebra.hh" #include "tests/test_goodies.hh" namespace muSpectre { BOOST_AUTO_TEST_SUITE(materials_toolbox) BOOST_FIXTURE_TEST_CASE_TEMPLATE(test_strain_conversion, Fix, testGoodies::dimlist, Fix) { constexpr Dim_t dim{Fix::dim}; using T2 = Eigen::Matrix; T2 F{(T2::Random() - .5 * T2::Ones()) / 20 + T2::Identity()}; // checking Green-Lagrange T2 Eref = .5 * (F.transpose() * F - T2::Identity()); T2 E_tb = MatTB::convert_strain( Eigen::Map>(F.data())); Real error = (Eref - E_tb).norm(); BOOST_CHECK_LT(error, tol); // checking Left Cauchy-Green Eref = F * F.transpose(); E_tb = MatTB::convert_strain(F); error = (Eref - E_tb).norm(); BOOST_CHECK_LT(error, tol); // checking Right Cauchy-Green Eref = F.transpose() * F; E_tb = MatTB::convert_strain(F); error = (Eref - E_tb).norm(); BOOST_CHECK_LT(error, tol); // checking Hencky (logarithmic) strain Eref = F.transpose() * F; Eigen::SelfAdjointEigenSolver EigSolv(Eref); Eref.setZero(); for (size_t i{0}; i < dim; ++i) { - auto &&vec = EigSolv.eigenvectors().col(i); - auto &&val = EigSolv.eigenvalues()(i); + auto && vec = EigSolv.eigenvectors().col(i); + auto && val = EigSolv.eigenvalues()(i); Eref += .5 * std::log(val) * vec * vec.transpose(); } E_tb = MatTB::convert_strain(F); error = (Eref - E_tb).norm(); BOOST_CHECK_LT(error, tol); auto F_tb = MatTB::convert_strain( F); error = (F - F_tb).norm(); BOOST_CHECK_LT(error, tol); } BOOST_FIXTURE_TEST_CASE_TEMPLATE(dumb_tensor_mult_test, Fix, testGoodies::dimlist, Fix) { constexpr Dim_t dim{Fix::dim}; using T4 = T4Mat; T4 A, B, R1, R2; A.setRandom(); B.setRandom(); R1 = A * B; R2.setZero(); for (Dim_t i = 0; i < dim; ++i) { for (Dim_t j = 0; j < dim; ++j) { for (Dim_t a = 0; a < dim; ++a) { for (Dim_t b = 0; b < dim; ++b) { for (Dim_t k = 0; k < dim; ++k) { for (Dim_t l = 0; l < dim; ++l) { get(R2, i, j, k, l) += get(A, i, j, a, b) * get(B, a, b, k, l); } } } } } } auto error{(R1 - R2).norm()}; BOOST_CHECK_LT(error, tol); } BOOST_FIXTURE_TEST_CASE_TEMPLATE(test_PK1_stress, Fix, testGoodies::dimlist, Fix) { using Matrices::Tens2_t; using Matrices::Tens4_t; using Matrices::tensmult; constexpr Dim_t dim{Fix::dim}; using T2 = Eigen::Matrix; using T4 = T4Mat; testGoodies::RandRange rng; T2 F = T2::Identity() * 2; // F.setRandom(); T2 E_tb = MatTB::convert_strain( Eigen::Map>(F.data())); Real lambda = 3; // rng.randval(1, 2); Real mu = 4; // rng.randval(1,2); T4 J = Matrices::Itrac(); T2 I = Matrices::I2(); T4 I4 = Matrices::Isymm(); T4 C = lambda * J + 2 * mu * I4; T2 S = Matrices::tensmult(C, E_tb); T2 Sref = lambda * E_tb.trace() * I + 2 * mu * E_tb; auto error{(Sref - S).norm()}; BOOST_CHECK_LT(error, tol); T4 K = Matrices::outer_under(I, S) + Matrices::outer_under(F, I) * C * Matrices::outer_under(F.transpose(), I); // See Curnier, 2000, "Méthodes numériques en mécanique des solides", p 252 T4 Kref; Real Fkrkr = (F.array() * F.array()).sum(); T2 Fkmkn = F.transpose() * F; T2 Fisjs = F * F.transpose(); Kref.setZero(); for (Dim_t i = 0; i < dim; ++i) { for (Dim_t j = 0; j < dim; ++j) { for (Dim_t m = 0; m < dim; ++m) { for (Dim_t n = 0; n < dim; ++n) { get(Kref, i, m, j, n) = (lambda * ((Fkrkr - dim) / 2 * I(i, j) * I(m, n) + F(i, m) * F(j, n)) + mu * (I(i, j) * Fkmkn(m, n) + Fisjs(i, j) * I(m, n) - I(i, j) * I(m, n) + F(i, n) * F(j, m))); } } } } error = (Kref - K).norm(); BOOST_CHECK_LT(error, tol); T2 P = MatTB::PK1_stress( F, S); T2 Pref = F * S; error = (P - Pref).norm(); BOOST_CHECK_LT(error, tol); - auto &&stress_tgt = + auto && stress_tgt = MatTB::PK1_stress( F, S, C); T2 P_t = std::move(std::get<0>(stress_tgt)); T4 K_t = std::move(std::get<1>(stress_tgt)); error = (P_t - Pref).norm(); BOOST_CHECK_LT(error, tol); error = (K_t - Kref).norm(); BOOST_CHECK_LT(error, tol); - auto &&stress_tgt_trivial = + auto && stress_tgt_trivial = MatTB::PK1_stress(F, P, K); T2 P_u = std::move(std::get<0>(stress_tgt_trivial)); T4 K_u = std::move(std::get<1>(stress_tgt_trivial)); error = (P_u - Pref).norm(); BOOST_CHECK_LT(error, tol); error = (K_u - Kref).norm(); BOOST_CHECK_LT(error, tol); T2 P_g; T4 K_g; std::tie(P_g, K_g) = testGoodies::objective_hooke_explicit(lambda, mu, F); error = (P_g - Pref).norm(); BOOST_CHECK_LT(error, tol); error = (K_g - Kref).norm(); BOOST_CHECK_LT(error, tol); } BOOST_AUTO_TEST_CASE(elastic_modulus_conversions) { // define original input constexpr Real E{123.456}; constexpr Real nu{.3}; using MatTB::convert_elastic_modulus; // derived values constexpr Real K{ convert_elastic_modulus(E, nu)}; constexpr Real lambda{ convert_elastic_modulus(E, nu)}; constexpr Real mu{ convert_elastic_modulus(E, nu)}; // recover original inputs Real comp = convert_elastic_modulus(K, mu); Real err = E - comp; BOOST_CHECK_LT(err, tol); comp = convert_elastic_modulus(K, mu); err = nu - comp; BOOST_CHECK_LT(err, tol); comp = convert_elastic_modulus(lambda, mu); err = E - comp; BOOST_CHECK_LT(err, tol); // check inversion resistance Real compA = convert_elastic_modulus(K, mu); Real compB = convert_elastic_modulus(mu, K); BOOST_CHECK_EQUAL(compA, compB); // check trivial self-returning comp = convert_elastic_modulus(K, mu); BOOST_CHECK_EQUAL(K, comp); comp = convert_elastic_modulus(K, mu); BOOST_CHECK_EQUAL(mu, comp); } BOOST_AUTO_TEST_SUITE_END(); } // namespace muSpectre diff --git a/tests/test_projection.hh b/tests/test_projection.hh index 4996f77..9888732 100644 --- a/tests/test_projection.hh +++ b/tests/test_projection.hh @@ -1,100 +1,105 @@ /** * @file test_projection.hh * * @author Till Junge * * @date 16 Jan 2018 * * @brief common declarations for testing both the small and finite strain * projection operators * * Copyright © 2018 Till Junge * * µSpectre 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, 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 Lesser General Public License * along with µSpectre; see the file COPYING. If not, write to the * Free Software Foundation, Inc., 59 Temple Place - Suite 330, * * Boston, MA 02111-1307, USA. * * Additional permission under GNU GPL version 3 section 7 * * If you modify this Program, or any covered work, by linking or combining it * with proprietary FFT implementations or numerical libraries, containing parts * covered by the terms of those libraries' licenses, the licensors of this * Program grant you additional permission to convey the resulting work. */ #include "tests.hh" #include "fft/fftw_engine.hh" #include #include #ifndef TESTS_TEST_PROJECTION_HH_ #define TESTS_TEST_PROJECTION_HH_ namespace muSpectre { /* ---------------------------------------------------------------------- */ - template struct Sizes {}; - template <> struct Sizes { + template + struct Sizes {}; + template <> + struct Sizes { constexpr static Ccoord_t get_resolution() { return Ccoord_t{3, 5}; } constexpr static Rcoord_t get_lengths() { return Rcoord_t{3.4, 5.8}; } }; - template <> struct Sizes { + template <> + struct Sizes { constexpr static Ccoord_t get_resolution() { return Ccoord_t{3, 5, 7}; } constexpr static Rcoord_t get_lengths() { return Rcoord_t{3.4, 5.8, 6.7}; } }; - template struct Squares {}; - template <> struct Squares { + template + struct Squares {}; + template <> + struct Squares { constexpr static Ccoord_t get_resolution() { return Ccoord_t{5, 5}; } constexpr static Rcoord_t get_lengths() { return Rcoord_t{5, 5}; } }; - template <> struct Squares { + template <> + struct Squares { constexpr static Ccoord_t get_resolution() { return Ccoord_t{7, 7, 7}; } constexpr static Rcoord_t get_lengths() { return Rcoord_t{7, 7, 7}; } }; /* ---------------------------------------------------------------------- */ template struct ProjectionFixture { using Engine = FFTWEngine; using Parent = Proj; constexpr static Dim_t sdim{DimS}; constexpr static Dim_t mdim{DimM}; ProjectionFixture() : projector(std::make_unique(SizeGiver::get_resolution(), mdim * mdim), SizeGiver::get_lengths()) {} Parent projector; }; } // namespace muSpectre - #endif // TESTS_TEST_PROJECTION_HH_ diff --git a/tests/test_projection_finite.cc b/tests/test_projection_finite.cc index 4586918..ade47fb 100644 --- a/tests/test_projection_finite.cc +++ b/tests/test_projection_finite.cc @@ -1,150 +1,150 @@ /** * @file test_projection_finite.cc * * @author Till Junge * * @date 07 Dec 2017 * * @brief tests for standard finite strain projection operator * * Copyright © 2017 Till Junge * * µSpectre 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, 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 Lesser General Public License * along with µSpectre; see the file COPYING. If not, write to the * Free Software Foundation, Inc., 59 Temple Place - Suite 330, * * Boston, MA 02111-1307, USA. * * Additional permission under GNU GPL version 3 section 7 * * If you modify this Program, or any covered work, by linking or combining it * with proprietary FFT implementations or numerical libraries, containing parts * covered by the terms of those libraries' licenses, the licensors of this * Program grant you additional permission to convey the resulting work. */ #include "fft/projection_finite_strain.hh" #include "fft/projection_finite_strain_fast.hh" #include "fft/fft_utils.hh" #include "test_projection.hh" #include namespace muSpectre { BOOST_AUTO_TEST_SUITE(projection_finite_strain); /* ---------------------------------------------------------------------- */ using fixlist = boost::mpl::list< ProjectionFixture, ProjectionFiniteStrain>, ProjectionFixture, ProjectionFiniteStrain>, ProjectionFixture, ProjectionFiniteStrain>, ProjectionFixture, ProjectionFiniteStrain>, ProjectionFixture, ProjectionFiniteStrainFast>, ProjectionFixture, ProjectionFiniteStrainFast>, ProjectionFixture, ProjectionFiniteStrainFast>, ProjectionFixture, ProjectionFiniteStrainFast>>; /* ---------------------------------------------------------------------- */ BOOST_FIXTURE_TEST_CASE_TEMPLATE(constructor_test, fix, fixlist, fix) { BOOST_CHECK_NO_THROW(fix::projector.initialise(FFT_PlanFlags::estimate)); } /* ---------------------------------------------------------------------- */ BOOST_AUTO_TEST_CASE(even_grid_test) { using Engine = FFTWEngine; using proj = ProjectionFiniteStrainFast; auto engine = std::make_unique(Ccoord_t{2, 2}, 2 * 2); BOOST_CHECK_THROW(proj(std::move(engine), Rcoord_t{4.3, 4.3}), std::runtime_error); } /* ---------------------------------------------------------------------- */ BOOST_FIXTURE_TEST_CASE_TEMPLATE(Gradient_preservation_test, fix, fixlist, fix) { // create a gradient field with a zero mean gradient and verify // that the projection preserves it constexpr Dim_t dim{fix::sdim}, sdim{fix::sdim}, mdim{fix::mdim}; static_assert( dim == fix::mdim, "These tests assume that the material and spatial dimension are " "identical"); using Fields = GlobalFieldCollection; using FieldT = TensorField; using FieldMap = MatrixFieldMap; using Vector = Eigen::Matrix; Fields fields{}; - FieldT &f_grad{make_field("gradient", fields)}; - FieldT &f_var{make_field("working field", fields)}; + FieldT & f_grad{make_field("gradient", fields)}; + FieldT & f_var{make_field("working field", fields)}; FieldMap grad(f_grad); FieldMap var(f_var); fields.initialise(fix::projector.get_subdomain_resolutions(), fix::projector.get_subdomain_locations()); FFT_freqs freqs{fix::projector.get_domain_resolutions(), fix::projector.get_domain_lengths()}; Vector k; for (Dim_t i = 0; i < dim; ++i) { // the wave vector has to be such that it leads to an integer // number of periods in each length of the domain k(i) = (i + 1) * 2 * pi / fix::projector.get_domain_lengths()[i]; } - for (auto &&tup : akantu::zip(fields, grad, var)) { - auto &ccoord = std::get<0>(tup); - auto &g = std::get<1>(tup); - auto &v = std::get<2>(tup); + for (auto && tup : akantu::zip(fields, grad, var)) { + auto & ccoord = std::get<0>(tup); + auto & g = std::get<1>(tup); + auto & v = std::get<2>(tup); Vector vec = CcoordOps::get_vector( ccoord, fix::projector.get_domain_lengths() / fix::projector.get_domain_resolutions()); g.row(0) = k.transpose() * cos(k.dot(vec)); v.row(0) = g.row(0); } fix::projector.initialise(FFT_PlanFlags::estimate); fix::projector.apply_projection(f_var); - for (auto &&tup : akantu::zip(fields, grad, var)) { - auto &ccoord = std::get<0>(tup); - auto &g = std::get<1>(tup); - auto &v = std::get<2>(tup); + for (auto && tup : akantu::zip(fields, grad, var)) { + auto & ccoord = std::get<0>(tup); + auto & g = std::get<1>(tup); + auto & v = std::get<2>(tup); Vector vec = CcoordOps::get_vector( ccoord, fix::projector.get_domain_lengths() / fix::projector.get_domain_resolutions()); Real error = (g - v).norm(); BOOST_CHECK_LT(error, tol); if (error >= tol) { std::cout << std::endl << "grad_ref :" << std::endl << g << std::endl; std::cout << std::endl << "grad_proj :" << std::endl << v << std::endl; std::cout << std::endl << "ccoord :" << std::endl << ccoord << std::endl; std::cout << std::endl << "vector :" << std::endl << vec.transpose() << std::endl; } } } BOOST_AUTO_TEST_SUITE_END(); } // namespace muSpectre diff --git a/tests/test_projection_small.cc b/tests/test_projection_small.cc index 8c474e2..29787f5 100644 --- a/tests/test_projection_small.cc +++ b/tests/test_projection_small.cc @@ -1,143 +1,143 @@ /** * @file test_projection_small.cc * * @author Till Junge * * @date 16 Jan 2018 * * @brief tests for standard small strain projection operator * * Copyright © 2018 Till Junge * * µSpectre 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, 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 Lesser General Public License * along with µSpectre; see the file COPYING. If not, write to the * Free Software Foundation, Inc., 59 Temple Place - Suite 330, * * Boston, MA 02111-1307, USA. * * Additional permission under GNU GPL version 3 section 7 * * If you modify this Program, or any covered work, by linking or combining it * with proprietary FFT implementations or numerical libraries, containing parts * covered by the terms of those libraries' licenses, the licensors of this * Program grant you additional permission to convey the resulting work. */ #include "fft/projection_small_strain.hh" #include "test_projection.hh" #include "fft/fft_utils.hh" #include namespace muSpectre { BOOST_AUTO_TEST_SUITE(projection_small_strain); using fixlist = boost::mpl::list< ProjectionFixture, ProjectionSmallStrain>, ProjectionFixture, ProjectionSmallStrain>, ProjectionFixture, ProjectionSmallStrain>, ProjectionFixture, ProjectionSmallStrain>>; /* ---------------------------------------------------------------------- */ BOOST_FIXTURE_TEST_CASE_TEMPLATE(constructor_test, fix, fixlist, fix) { BOOST_CHECK_NO_THROW(fix::projector.initialise(FFT_PlanFlags::estimate)); } /* ---------------------------------------------------------------------- */ BOOST_FIXTURE_TEST_CASE_TEMPLATE(Gradient_preservation_test, fix, fixlist, fix) { // create a gradient field with a zero mean gradient and verify // that the projection preserves it constexpr Dim_t dim{fix::sdim}, sdim{fix::sdim}, mdim{fix::mdim}; static_assert( dim == fix::mdim, "These tests assume that the material and spatial dimension are " "identical"); using Fields = GlobalFieldCollection; using FieldT = TensorField; using FieldMap = MatrixFieldMap; using Vector = Eigen::Matrix; Fields fields{}; - FieldT &f_grad{make_field("strain", fields)}; - FieldT &f_var{make_field("working field", fields)}; + FieldT & f_grad{make_field("strain", fields)}; + FieldT & f_var{make_field("working field", fields)}; FieldMap grad(f_grad); FieldMap var(f_var); fields.initialise(fix::projector.get_subdomain_resolutions(), fix::projector.get_subdomain_locations()); FFT_freqs freqs{fix::projector.get_domain_resolutions(), fix::projector.get_domain_lengths()}; Vector k; for (Dim_t i = 0; i < dim; ++i) { // the wave vector has to be such that it leads to an integer // number of periods in each length of the domain k(i) = (i + 1) * 2 * pi / fix::projector.get_domain_lengths()[i]; } - for (auto &&tup : akantu::zip(fields, grad, var)) { - auto &ccoord = std::get<0>(tup); - auto &g = std::get<1>(tup); - auto &v = std::get<2>(tup); + for (auto && tup : akantu::zip(fields, grad, var)) { + auto & ccoord = std::get<0>(tup); + auto & g = std::get<1>(tup); + auto & v = std::get<2>(tup); Vector vec = CcoordOps::get_vector( ccoord, fix::projector.get_domain_lengths() / fix::projector.get_domain_resolutions()); g.row(0) << k.transpose() * cos(k.dot(vec)); // We need to add I to the term, because this field has a net // zero gradient, which leads to a net -I strain g = 0.5 * ((g - g.Identity()).transpose() + (g - g.Identity())).eval() + g.Identity(); v = g; } fix::projector.initialise(FFT_PlanFlags::estimate); fix::projector.apply_projection(f_var); constexpr bool verbose{false}; - for (auto &&tup : akantu::zip(fields, grad, var)) { - auto &ccoord = std::get<0>(tup); - auto &g = std::get<1>(tup); - auto &v = std::get<2>(tup); + for (auto && tup : akantu::zip(fields, grad, var)) { + auto & ccoord = std::get<0>(tup); + auto & g = std::get<1>(tup); + auto & v = std::get<2>(tup); Vector vec = CcoordOps::get_vector( ccoord, fix::projector.get_domain_lengths() / fix::projector.get_domain_resolutions()); Real error = (g - v).norm(); BOOST_CHECK_LT(error, tol); if ((error >= tol) || verbose) { std::cout << std::endl << "grad_ref :" << std::endl << g << std::endl; std::cout << std::endl << "grad_proj :" << std::endl << v << std::endl; std::cout << std::endl << "ccoord :" << std::endl << ccoord << std::endl; std::cout << std::endl << "vector :" << std::endl << vec.transpose() << std::endl; std::cout << "means:" << std::endl << ":" << std::endl << grad.mean() << std::endl << ":" << std::endl << var.mean(); } } } BOOST_AUTO_TEST_SUITE_END(); } // namespace muSpectre diff --git a/tests/test_solver_newton_cg.cc b/tests/test_solver_newton_cg.cc index 83d1852..16db226 100644 --- a/tests/test_solver_newton_cg.cc +++ b/tests/test_solver_newton_cg.cc @@ -1,478 +1,481 @@ /** * @file test_solver_newton_cg.cc * * @author Till Junge * * @date 20 Dec 2017 * * @brief Tests for the standard Newton-Raphson + Conjugate Gradient solver * * Copyright © 2017 Till Junge * * µSpectre 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, 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 Lesser General Public License * along with µSpectre; see the file COPYING. If not, write to the * Free Software Foundation, Inc., 59 Temple Place - Suite 330, * * Boston, MA 02111-1307, USA. * * Additional permission under GNU GPL version 3 section 7 * * If you modify this Program, or any covered work, by linking or combining it * with proprietary FFT implementations or numerical libraries, containing parts * covered by the terms of those libraries' licenses, the licensors of this * Program grant you additional permission to convey the resulting work. */ #include "tests.hh" #include "solver/solvers.hh" #include "solver/solver_cg.hh" #include "solver/solver_eigen.hh" #include "solver/deprecated_solvers.hh" #include "solver/deprecated_solver_cg.hh" #include "solver/deprecated_solver_cg_eigen.hh" #include "fft/fftw_engine.hh" #include "fft/projection_finite_strain_fast.hh" #include "materials/material_linear_elastic1.hh" #include "common/iterators.hh" #include "common/ccoord_operations.hh" #include "cell/cell_factory.hh" #include namespace muSpectre { BOOST_AUTO_TEST_SUITE(newton_cg_tests); BOOST_AUTO_TEST_CASE(manual_construction_test) { // constexpr Dim_t dim{twoD}; constexpr Dim_t dim{threeD}; // constexpr Ccoord_t resolutions{3, 3}; // constexpr Rcoord_t lengths{2.3, 2.7}; constexpr Ccoord_t resolutions{5, 5, 5}; constexpr Rcoord_t lengths{5, 5, 5}; auto fft_ptr{std::make_unique>(resolutions, ipow(dim, 2))}; auto proj_ptr{std::make_unique>( std::move(fft_ptr), lengths)}; CellBase sys(std::move(proj_ptr)); using Mat_t = MaterialLinearElastic1; // const Real Young{210e9}, Poisson{.33}; const Real Young{1.0030648180242636}, Poisson{0.29930675909878679}; // const Real lambda{Young*Poisson/((1+Poisson)*(1-2*Poisson))}; // const Real mu{Young/(2*(1+Poisson))}; - auto &Material_hard = Mat_t::make(sys, "hard", 10 * Young, Poisson); - auto &Material_soft = Mat_t::make(sys, "soft", Young, Poisson); + auto & Material_hard = Mat_t::make(sys, "hard", 10 * Young, Poisson); + auto & Material_soft = Mat_t::make(sys, "soft", Young, Poisson); - for (auto &&tup : akantu::enumerate(sys)) { - auto &&pixel = std::get<1>(tup); + for (auto && tup : akantu::enumerate(sys)) { + auto && pixel = std::get<1>(tup); if (std::get<0>(tup) == 0) { Material_hard.add_pixel(pixel); } else { Material_soft.add_pixel(pixel); } } sys.initialise(); Grad_t delF0; delF0 << 0, 1., 0, 0, 0, 0, 0, 0, 0; constexpr Real cg_tol{1e-8}, newton_tol{1e-5}; constexpr Uint maxiter{CcoordOps::get_size(resolutions) * ipow(dim, secondOrder) * 10}; constexpr bool verbose{false}; GradIncrements grads; grads.push_back(delF0); DeprecatedSolverCG cg{sys, cg_tol, maxiter, static_cast(verbose)}; Eigen::ArrayXXd res1{ deprecated_de_geus(sys, grads, cg, newton_tol, verbose)[0].grad}; DeprecatedSolverCG cg2{sys, cg_tol, maxiter, static_cast(verbose)}; Eigen::ArrayXXd res2{ deprecated_newton_cg(sys, grads, cg2, newton_tol, verbose)[0].grad}; BOOST_CHECK_LE(abs(res1 - res2).mean(), cg_tol); } BOOST_AUTO_TEST_CASE(small_strain_patch_test) { constexpr Dim_t dim{twoD}; using Ccoord = Ccoord_t; using Rcoord = Rcoord_t; constexpr Ccoord resolutions{CcoordOps::get_cube(3)}; constexpr Rcoord lengths{CcoordOps::get_cube(1.)}; constexpr Formulation form{Formulation::small_strain}; // number of layers in the hard material constexpr Uint nb_lays{1}; constexpr Real contrast{2}; static_assert(nb_lays < resolutions[0], "the number or layers in the hard material must be smaller " "than the total number of layers in dimension 0"); auto sys{make_cell(resolutions, lengths, form)}; using Mat_t = MaterialLinearElastic1; constexpr Real Young{2.}, Poisson{.33}; auto material_hard{ std::make_unique("hard", contrast * Young, Poisson)}; auto material_soft{std::make_unique("soft", Young, Poisson)}; - for (const auto &pixel : sys) { + for (const auto & pixel : sys) { if (pixel[0] < Dim_t(nb_lays)) { material_hard->add_pixel(pixel); } else { material_soft->add_pixel(pixel); } } sys.add_material(std::move(material_hard)); sys.add_material(std::move(material_soft)); sys.initialise(); Grad_t delEps0{Grad_t::Zero()}; constexpr Real eps0 = 1.; // delEps0(0, 1) = delEps0(1, 0) = eps0; delEps0(0, 0) = eps0; constexpr Real cg_tol{1e-8}, newton_tol{1e-5}, equil_tol{1e-10}; constexpr Uint maxiter{dim * 10}; constexpr Dim_t verbose{0}; DeprecatedSolverCGEigen cg{sys, cg_tol, maxiter, static_cast(verbose)}; auto result = deprecated_newton_cg( sys, delEps0, cg, newton_tol, // de_geus(sys, delEps0, cg, newton_tol, equil_tol, verbose); if (verbose) { std::cout << "result:" << std::endl << result.grad << std::endl; std::cout << "mean strain = " << std::endl << sys.get_strain().get_map().mean() << std::endl; } /** * verification of resultant strains: subscript ₕ for hard and ₛ * for soft, Nₕ is nb_lays and Nₜₒₜ is resolutions, k is contrast * * Δl = εl = Δlₕ + Δlₛ = εₕlₕ+εₛlₛ * => ε = εₕ Nₕ/Nₜₒₜ + εₛ (Nₜₒₜ-Nₕ)/Nₜₒₜ * * σ is constant across all layers * σₕ = σₛ * => Eₕ εₕ = Eₛ εₛ * => εₕ = 1/k εₛ * => ε / (1/k Nₕ/Nₜₒₜ + (Nₜₒₜ-Nₕ)/Nₜₒₜ) = εₛ */ constexpr Real factor{1 / contrast * Real(nb_lays) / resolutions[0] + 1. - nb_lays / Real(resolutions[0])}; constexpr Real eps_soft{eps0 / factor}; constexpr Real eps_hard{eps_soft / contrast}; if (verbose) { std::cout << "εₕ = " << eps_hard << ", εₛ = " << eps_soft << std::endl; std::cout << "ε = εₕ Nₕ/Nₜₒₜ + εₛ (Nₜₒₜ-Nₕ)/Nₜₒₜ" << std::endl; } Grad_t Eps_hard; Eps_hard << eps_hard, 0, 0, 0; Grad_t Eps_soft; Eps_soft << eps_soft, 0, 0, 0; // verify uniaxial tension patch test - for (const auto &pixel : sys) { + for (const auto & pixel : sys) { if (pixel[0] < Dim_t(nb_lays)) { BOOST_CHECK_LE((Eps_hard - sys.get_strain().get_map()[pixel]).norm(), tol); } else { BOOST_CHECK_LE((Eps_soft - sys.get_strain().get_map()[pixel]).norm(), tol); } } delEps0 = Grad_t::Zero(); delEps0(0, 1) = delEps0(1, 0) = eps0; DeprecatedSolverCG cg2{sys, cg_tol, maxiter, static_cast(verbose)}; result = deprecated_newton_cg(sys, delEps0, cg2, newton_tol, equil_tol, verbose); Eps_hard << 0, eps_hard, eps_hard, 0; Eps_soft << 0, eps_soft, eps_soft, 0; // verify pure shear patch test - for (const auto &pixel : sys) { + for (const auto & pixel : sys) { if (pixel[0] < Dim_t(nb_lays)) { BOOST_CHECK_LE((Eps_hard - sys.get_strain().get_map()[pixel]).norm(), tol); } else { BOOST_CHECK_LE((Eps_soft - sys.get_strain().get_map()[pixel]).norm(), tol); } } } - template struct SolverFixture { using type = SolverType; }; + template + struct SolverFixture { + using type = SolverType; + }; using SolverList = boost::mpl::list< SolverFixture, SolverFixture, SolverFixture, SolverFixture, SolverFixture, SolverFixture>; BOOST_FIXTURE_TEST_CASE_TEMPLATE(small_strain_patch_dynamic_solver, Fix, SolverList, Fix) { // BOOST_AUTO_TEST_CASE(small_strain_patch_test_dynamic_solver) { constexpr Dim_t dim{twoD}; using Ccoord = Ccoord_t; using Rcoord = Rcoord_t; constexpr Ccoord resolutions{CcoordOps::get_cube(3)}; constexpr Rcoord lengths{CcoordOps::get_cube(1.)}; constexpr Formulation form{Formulation::small_strain}; // number of layers in the hard material constexpr Uint nb_lays{1}; constexpr Real contrast{2}; static_assert(nb_lays < resolutions[0], "the number or layers in the hard material must be smaller " "than the total number of layers in dimension 0"); auto sys{make_cell(resolutions, lengths, form)}; using Mat_t = MaterialLinearElastic1; constexpr Real Young{2.}, Poisson{.33}; auto material_hard{ std::make_unique("hard", contrast * Young, Poisson)}; auto material_soft{std::make_unique("soft", Young, Poisson)}; - for (const auto &pixel : sys) { + for (const auto & pixel : sys) { if (pixel[0] < Dim_t(nb_lays)) { material_hard->add_pixel(pixel); } else { material_soft->add_pixel(pixel); } } sys.add_material(std::move(material_hard)); sys.add_material(std::move(material_soft)); sys.initialise(); Grad_t delEps0{Grad_t::Zero()}; constexpr Real eps0 = 1.; // delEps0(0, 1) = delEps0(1, 0) = eps0; delEps0(0, 0) = eps0; constexpr Real cg_tol{1e-8}, newton_tol{1e-5}, equil_tol{1e-10}; constexpr Uint maxiter{dim * 10}; constexpr Dim_t verbose{0}; using Solver_t = typename Fix::type; Solver_t cg{sys, cg_tol, maxiter, static_cast(verbose)}; auto result = newton_cg(sys, delEps0, cg, newton_tol, equil_tol, verbose); if (verbose) { std::cout << "result:" << std::endl << result.grad << std::endl; std::cout << "mean strain = " << std::endl << sys.get_strain().get_map().mean() << std::endl; } /** * verification of resultant strains: subscript ₕ for hard and ₛ * for soft, Nₕ is nb_lays and Nₜₒₜ is resolutions, k is contrast * * Δl = εl = Δlₕ + Δlₛ = εₕlₕ+εₛlₛ * => ε = εₕ Nₕ/Nₜₒₜ + εₛ (Nₜₒₜ-Nₕ)/Nₜₒₜ * * σ is constant across all layers * σₕ = σₛ * => Eₕ εₕ = Eₛ εₛ * => εₕ = 1/k εₛ * => ε / (1/k Nₕ/Nₜₒₜ + (Nₜₒₜ-Nₕ)/Nₜₒₜ) = εₛ */ constexpr Real factor{1 / contrast * Real(nb_lays) / resolutions[0] + 1. - nb_lays / Real(resolutions[0])}; constexpr Real eps_soft{eps0 / factor}; constexpr Real eps_hard{eps_soft / contrast}; if (verbose) { std::cout << "εₕ = " << eps_hard << ", εₛ = " << eps_soft << std::endl; std::cout << "ε = εₕ Nₕ/Nₜₒₜ + εₛ (Nₜₒₜ-Nₕ)/Nₜₒₜ" << std::endl; } Grad_t Eps_hard; Eps_hard << eps_hard, 0, 0, 0; Grad_t Eps_soft; Eps_soft << eps_soft, 0, 0, 0; // verify uniaxial tension patch test - for (const auto &pixel : sys) { + for (const auto & pixel : sys) { if (pixel[0] < Dim_t(nb_lays)) { BOOST_CHECK_LE((Eps_hard - sys.get_strain().get_map()[pixel]).norm(), tol); } else { BOOST_CHECK_LE((Eps_soft - sys.get_strain().get_map()[pixel]).norm(), tol); } } delEps0 = Grad_t::Zero(); delEps0(0, 1) = delEps0(1, 0) = eps0; Solver_t cg2{sys, cg_tol, maxiter, static_cast(verbose)}; result = de_geus(sys, delEps0, cg2, newton_tol, equil_tol, verbose); Eps_hard << 0, eps_hard, eps_hard, 0; Eps_soft << 0, eps_soft, eps_soft, 0; // verify pure shear patch test - for (const auto &pixel : sys) { + for (const auto & pixel : sys) { if (pixel[0] < Dim_t(nb_lays)) { BOOST_CHECK_LE((Eps_hard - sys.get_strain().get_map()[pixel]).norm(), tol); } else { BOOST_CHECK_LE((Eps_soft - sys.get_strain().get_map()[pixel]).norm(), tol); } } } BOOST_AUTO_TEST_CASE(small_strain_patch_test_new_interface_manual) { constexpr Dim_t dim{twoD}; using Ccoord = Ccoord_t; using Rcoord = Rcoord_t; constexpr Ccoord resolutions{CcoordOps::get_cube(3)}; constexpr Rcoord lengths{CcoordOps::get_cube(1.)}; constexpr Formulation form{Formulation::small_strain}; // number of layers in the hard material constexpr Uint nb_lays{1}; constexpr Real contrast{2}; static_assert(nb_lays < resolutions[0], "the number or layers in the hard material must be smaller " "than the total number of layers in dimension 0"); auto sys{make_cell(resolutions, lengths, form)}; using Mat_t = MaterialLinearElastic1; constexpr Real Young{2.}, Poisson{.33}; auto material_hard{ std::make_unique("hard", contrast * Young, Poisson)}; auto material_soft{std::make_unique("soft", Young, Poisson)}; - for (const auto &pixel : sys) { + for (const auto & pixel : sys) { if (pixel[0] < Dim_t(nb_lays)) { material_hard->add_pixel(pixel); } else { material_soft->add_pixel(pixel); } } sys.add_material(std::move(material_hard)); sys.add_material(std::move(material_soft)); Grad_t delEps0{Grad_t::Zero()}; constexpr Real eps0 = 1.; // delEps0(0, 1) = delEps0(1, 0) = eps0; delEps0(0, 0) = eps0; constexpr Real cg_tol{1e-8}; constexpr Uint maxiter{dim * 10}; constexpr Dim_t verbose{0}; DeprecatedSolverCGEigen cg{sys, cg_tol, maxiter, static_cast(verbose)}; auto F = sys.get_strain_vector(); F.setZero(); sys.evaluate_stress_tangent(); Eigen::VectorXd DelF(sys.get_nb_dof()); using RMap_t = RawFieldMap>>; for (auto tmp : RMap_t(DelF)) { tmp = delEps0; } Eigen::VectorXd rhs = -sys.evaluate_projected_directional_stiffness(DelF); F += DelF; DelF.setZero(); cg.initialise(); Eigen::Map(DelF.data(), DelF.size()) = cg.solve(rhs, DelF); F += DelF; if (verbose) { std::cout << "result:" << std::endl << F << std::endl; std::cout << "mean strain = " << std::endl << sys.get_strain().get_map().mean() << std::endl; } /** * verification of resultant strains: subscript ₕ for hard and ₛ * for soft, Nₕ is nb_lays and Nₜₒₜ is resolutions, k is contrast * * Δl = εl = Δlₕ + Δlₛ = εₕlₕ+εₛlₛ * => ε = εₕ Nₕ/Nₜₒₜ + εₛ (Nₜₒₜ-Nₕ)/Nₜₒₜ * * σ is constant across all layers * σₕ = σₛ * => Eₕ εₕ = Eₛ εₛ * => εₕ = 1/k εₛ * => ε / (1/k Nₕ/Nₜₒₜ + (Nₜₒₜ-Nₕ)/Nₜₒₜ) = εₛ */ constexpr Real factor{1 / contrast * Real(nb_lays) / resolutions[0] + 1. - nb_lays / Real(resolutions[0])}; constexpr Real eps_soft{eps0 / factor}; constexpr Real eps_hard{eps_soft / contrast}; if (verbose) { std::cout << "εₕ = " << eps_hard << ", εₛ = " << eps_soft << std::endl; std::cout << "ε = εₕ Nₕ/Nₜₒₜ + εₛ (Nₜₒₜ-Nₕ)/Nₜₒₜ" << std::endl; } Grad_t Eps_hard; Eps_hard << eps_hard, 0, 0, 0; Grad_t Eps_soft; Eps_soft << eps_soft, 0, 0, 0; // verify uniaxial tension patch test - for (const auto &pixel : sys) { + for (const auto & pixel : sys) { if (pixel[0] < Dim_t(nb_lays)) { BOOST_CHECK_LE((Eps_hard - sys.get_strain().get_map()[pixel]).norm(), tol); } else { BOOST_CHECK_LE((Eps_soft - sys.get_strain().get_map()[pixel]).norm(), tol); } } delEps0.setZero(); delEps0(0, 1) = delEps0(1, 0) = eps0; DeprecatedSolverCG cg2{sys, cg_tol, maxiter, static_cast(verbose)}; F.setZero(); sys.evaluate_stress_tangent(); for (auto tmp : RMap_t(DelF)) { tmp = delEps0; } rhs = -sys.evaluate_projected_directional_stiffness(DelF); F += DelF; DelF.setZero(); cg2.initialise(); DelF = cg2.solve(rhs, DelF); F += DelF; Eps_hard << 0, eps_hard, eps_hard, 0; Eps_soft << 0, eps_soft, eps_soft, 0; // verify pure shear patch test - for (const auto &pixel : sys) { + for (const auto & pixel : sys) { if (pixel[0] < Dim_t(nb_lays)) { BOOST_CHECK_LE((Eps_hard - sys.get_strain().get_map()[pixel]).norm(), tol); } else { BOOST_CHECK_LE((Eps_soft - sys.get_strain().get_map()[pixel]).norm(), tol); } } } BOOST_AUTO_TEST_SUITE_END(); } // namespace muSpectre