Optimizations.cpp

Go to the documentation of this file.

#include <polyfem/optimization/Optimizations.hpp>
 
#include <polyfem/varforms/diff/DifferentiableVarForm.hpp>
#include <polyfem/Common.hpp>
 
#include <polyfem/optimization/VarFormDiff.hpp>
#include <polyfem/optimization/AdjointNLProblem.hpp>
#include <polyfem/optimization/forms/SpatialIntegralForms.hpp>
#include <polyfem/optimization/forms/SumCompositeForm.hpp>
#include <polyfem/optimization/forms/CompositeForms.hpp>
#include <polyfem/optimization/forms/TransientForm.hpp>
#include <polyfem/optimization/forms/SmoothingForms.hpp>
#include <polyfem/optimization/forms/AMIPSForm.hpp>
#include <polyfem/optimization/forms/BarrierForms.hpp>
#include <polyfem/optimization/forms/SurfaceTractionForms.hpp>
#include <polyfem/optimization/forms/TargetForms.hpp>
#include <polyfem/optimization/forms/ParametrizedProductForm.hpp>
#include <polyfem/optimization/parametrization/Parametrizations.hpp>
#include <polyfem/optimization/parametrization/SplineParametrizations.hpp>
 
#include <polyfem/utils/JSONUtils.hpp>
#include <polyfem/utils/Logger.hpp>
 
#include <polyfem/mesh/GeometryReader.hpp>
 
#include <polyfem/io/OBJReader.hpp>
#include <polyfem/io/MatrixIO.hpp>
 
#include <polysolve/nonlinear/BoxConstraintSolver.hpp>
#include <polysolve/linear/Solver.hpp>
 
#include <jse/jse.h>
#include <polyfem/embedded_spec/polyfem_opt.hpp>
#include <polyfem/embedded_spec/polyfem_objective.hpp>
 
#include <Eigen/Core>
 
#include <memory>
#include <algorithm>
#include <fstream>
#include <vector>
#include <string>
#include <set>
#include <stdexcept>
 
namespace spdlog::level
{
    NLOHMANN_JSON_SERIALIZE_ENUM(
        spdlog::level::level_enum,
        {{spdlog::level::level_enum::trace, "trace"},
         {spdlog::level::level_enum::debug, "debug"},
         {spdlog::level::level_enum::info, "info"},
         {spdlog::level::level_enum::warn, "warning"},
         {spdlog::level::level_enum::err, "error"},
         {spdlog::level::level_enum::critical, "critical"},
         {spdlog::level::level_enum::off, "off"},
         {spdlog::level::level_enum::trace, 0},
         {spdlog::level::level_enum::debug, 1},
         {spdlog::level::level_enum::info, 2},
         {spdlog::level::level_enum::warn, 3},
         {spdlog::level::level_enum::err, 3},
         {spdlog::level::level_enum::critical, 4},
         {spdlog::level::level_enum::off, 5}})
}
 
namespace polyfem::solver
{
 
    std::shared_ptr<polysolve::nonlinear::Solver> AdjointOptUtils::make_nl_solver(
        const json &solver_params,
        const json &linear_solver_params,
        const double characteristic_length,
        const bool strict_validation)
    {
        auto names = polysolve::nonlinear::Solver::available_solvers();
        if (std::find(names.begin(), names.end(), solver_params["solver"]) != names.end())
            return polysolve::nonlinear::Solver::create(
                solver_params, linear_solver_params, characteristic_length, adjoint_logger(), strict_validation);
 
        names = polysolve::nonlinear::BoxConstraintSolver::available_solvers();
        if (std::find(names.begin(), names.end(), solver_params["solver"]) != names.end())
            return polysolve::nonlinear::BoxConstraintSolver::create(
                solver_params, linear_solver_params, characteristic_length, adjoint_logger(), strict_validation);
 
        log_and_throw_adjoint_error("Invalid nonlinear solver name!");
    }
 
    Eigen::VectorXd AdjointOptUtils::inverse_evaluation(const json &args, const int ndof, const std::vector<int> &variable_sizes, VariableToSimulationGroup &var2sim)
    {
        // Auto mode, pure inverse eval.
        if (args.is_string() && args.get<std::string>() == "auto")
        {
            Eigen::VectorXd x = var2sim.data[0]->inverse_eval();
            if (x.size() != ndof)
            {
                log_and_throw_adjoint_error("inverse_eval() returned {} DOF, expected {}.", x.size(), ndof);
            }
            return x;
        }
 
        // Manual mode.
        // 1. Try get initial specified by user first.
        // 2. Fallback to inverse_eval.
        Eigen::VectorXd x;
        x.setZero(ndof);
        int accumulative = 0;
        int var = 0;
        for (const auto &arg : args)
        {
            const auto &arg_initial = arg["initial"];
            Eigen::VectorXd tmp(variable_sizes[var]);
            if (arg_initial.is_array() && arg_initial.size() > 0)
            {
                tmp = arg_initial;
                x.segment(accumulative, tmp.size()) = tmp;
            }
            else if (arg_initial.is_number())
            {
                tmp.setConstant(arg_initial.get<double>());
                x.segment(accumulative, tmp.size()) = tmp;
            }
            else
            {
                // We seem to assume var2sim maps to parameter block in perfect order.
                // But since either json spec or other part of the code enforce this, it's
                // dangerous to rely on it.
                if (var2sim.data.size() != 1)
                {
                    logger().warn("Computing initial guess via inverse eval with multiple"
                                  " variable to simulation. You should make sure var2sim maps one"
                                  " to one to optimization parameter blocks in perfect order.");
                }
                x += var2sim.data[var]->inverse_eval();
            }
 
            accumulative += tmp.size();
            var++;
        }
 
        return x;
    }
 
    void AdjointOptUtils::solve_pde(varform::DifferentiableVarForm &varform)
    {
        Eigen::MatrixXd solution;
        varform.solve(solution, nullptr, {}, false);
    }
 
    void apply_objective_json_spec(json &args, const json &rules)
    {
        if (args.is_array())
        {
            for (auto &arg : args)
                apply_objective_json_spec(arg, rules);
        }
        else if (args.is_object())
        {
            jse::JSE jse;
            const bool valid_input = jse.verify_json(args, rules);
 
            if (!valid_input)
            {
                logger().error("invalid objective json:\n{}", jse.log2str());
                throw std::runtime_error("Invalid objective json file");
            }
 
            args = jse.inject_defaults(args, rules);
 
            for (auto &it : args.items())
            {
                if (it.key().find("objective") != std::string::npos)
                    apply_objective_json_spec(it.value(), rules);
            }
        }
    }
 
    json AdjointOptUtils::apply_opt_json_spec(const json &input_args, bool strict_validation)
    {
        json args_in = input_args;
 
        // CHECK validity json
        json rules;
        jse::JSE jse;
        {
            jse.strict = strict_validation;
            rules = jse::embed::polyfem_opt_spec::polyfem_opt::spec();
 
            polysolve::linear::Solver::apply_default_solver(rules, "/solver/linear");
        }
 
        if (args_in.contains("/solver/linear"_json_pointer))
            polysolve::linear::Solver::select_valid_solver(args_in["solver"]["linear"], logger());
 
        const bool valid_input = jse.verify_json(args_in, rules);
 
        if (!valid_input)
        {
            logger().error("invalid input json:\n{}", jse.log2str());
            throw std::runtime_error("Invalid input json file");
        }
 
        json args = jse.inject_defaults(args_in, rules);
 
        const json obj_rules = jse::embed::polyfem_objective_spec::polyfem_objective::spec();
        apply_objective_json_spec(args["functionals"], obj_rules);
 
        apply_objective_json_spec(args["stopping_conditions"], obj_rules);
 
        return args;
    }
 
    int AdjointOptUtils::compute_variable_size(const json &args, const std::vector<std::shared_ptr<varform::DifferentiableVarForm>> &varforms)
    {
        if (args["number"].is_number())
        {
            return args["number"].get<int>();
        }
        else if (args["number"].is_null() && args["initial"].size() > 0)
        {
            return args["initial"].size();
        }
        else if (args["number"].is_object())
        {
            auto selection = args["number"];
            if (selection.contains("surface_selection"))
            {
                auto surface_selection = selection["surface_selection"].get<std::vector<int>>();
                auto varform_id = selection["state"];
                std::set<int> node_ids = {};
                for (const auto &surface : surface_selection)
                {
                    std::vector<int> ids;
                    compute_surface_node_ids(*varforms[varform_id], surface, ids);
                    for (const auto &i : ids)
                        node_ids.insert(i);
                }
                return node_ids.size() * varforms[varform_id]->get_mesh().dimension();
            }
            else if (selection.contains("volume_selection"))
            {
                auto volume_selection = selection["volume_selection"].get<std::vector<int>>();
                auto varform_id = selection["state"];
                std::set<int> node_ids = {};
                for (const auto &volume : volume_selection)
                {
                    std::vector<int> ids;
                    compute_volume_node_ids(*varforms[varform_id], volume, ids);
                    for (const auto &i : ids)
                        node_ids.insert(i);
                }
 
                if (selection["exclude_boundary_nodes"])
                {
                    std::vector<int> ids;
                    compute_total_surface_node_ids(*varforms[varform_id], ids);
                    for (const auto &i : ids)
                        node_ids.erase(i);
                }
 
                return node_ids.size() * varforms[varform_id]->get_mesh().dimension();
            }
        }
 
        log_and_throw_adjoint_error("Incorrect specification for parameters.");
        return -1;
    }
} // namespace polyfem::solver