/**
 * \file
 * \copyright
 * Copyright (c) 2012-2023, OpenGeoSys Community (http://www.opengeosys.org)
 *            Distributed under a Modified BSD License.
 *              See accompanying file LICENSE.txt or
 *              http://www.opengeosys.org/project/license
 *
 */

#include "CreatePhaseFieldProcess.h"

#include <cassert>

#include "MaterialLib/SolidModels/CreateConstitutiveRelation.h"
#include "MaterialLib/SolidModels/MechanicsBase.h"
#include "ParameterLib/Utils.h"
#include "PhaseFieldProcess.h"
#include "PhaseFieldProcessData.h"
#include "ProcessLib/Output/CreateSecondaryVariables.h"
#include "ProcessLib/Utils/ProcessUtils.h"

namespace ProcessLib
{
namespace PhaseField
{
template <int DisplacementDim>
std::unique_ptr<Process> createPhaseFieldProcess(
    std::string name,
    MeshLib::Mesh& mesh,
    std::unique_ptr<ProcessLib::AbstractJacobianAssembler>&& jacobian_assembler,
    std::vector<ProcessVariable> const& variables,
    std::vector<std::unique_ptr<ParameterLib::ParameterBase>> const& parameters,
    std::optional<ParameterLib::CoordinateSystem> const&
        local_coordinate_system,
    unsigned const integration_order,
    BaseLib::ConfigTree const& config)
{
    //! \ogs_file_param{prj__processes__process__type}
    config.checkConfigParameter("type", "PHASE_FIELD");
    DBUG("Create PhaseFieldProcess.");

    auto const coupling_scheme =
        //! \ogs_file_param{prj__processes__process__PHASE_FIELD__coupling_scheme}
        config.getConfigParameterOptional<std::string>("coupling_scheme");
    const bool use_monolithic_scheme =
        !(coupling_scheme && (*coupling_scheme == "staggered"));

    /// \section processvariablespf Process Variables

    //! \ogs_file_param{prj__processes__process__PHASE_FIELD__process_variables}
    auto const pv_config = config.getConfigSubtree("process_variables");

    ProcessVariable* variable_ph;
    ProcessVariable* variable_u;
    std::vector<std::vector<std::reference_wrapper<ProcessVariable>>>
        process_variables;
    if (use_monolithic_scheme)  // monolithic scheme.
    {
        OGS_FATAL("Monolithic implementation is not available.");
    }
    else  // staggered scheme.
    {
        using namespace std::string_literals;
        for (
            /// Primary process variables as they appear in the global component
            /// vector:
            auto const& variable_name :
            {//! \ogs_file_param_special{prj__processes__process__PHASE_FIELD__process_variables__displacement}
             "displacement"s,
             //! \ogs_file_param_special{prj__processes__process__PHASE_FIELD__process_variables__phasefield}
             "phasefield"s})
        {
            auto per_process_variables =
                findProcessVariables(variables, pv_config, {variable_name});
            process_variables.push_back(std::move(per_process_variables));
        }
        variable_u = &process_variables[0][0].get();
        variable_ph = &process_variables[1][0].get();
    }

    DBUG("Associate displacement with process variable '{:s}'.",
         variable_u->getName());

    if (variable_u->getNumberOfGlobalComponents() != DisplacementDim)
    {
        OGS_FATAL(
            "Number of components of the process variable '{:s}' is different "
            "from the displacement dimension: got {:d}, expected {:d}",
            variable_u->getName(),
            variable_u->getNumberOfGlobalComponents(),
            DisplacementDim);
    }

    DBUG("Associate phase field with process variable '{:s}'.",
         variable_ph->getName());
    if (variable_ph->getNumberOfGlobalComponents() != 1)
    {
        OGS_FATAL(
            "Phasefield process variable '{:s}' is not a scalar variable but "
            "has {:d} components.",
            variable_ph->getName(),
            variable_ph->getNumberOfGlobalComponents());
    }
    /// \section parameterspf Process Parameters
    auto solid_constitutive_relations =
        MaterialLib::Solids::createConstitutiveRelations<DisplacementDim>(
            parameters, local_coordinate_system, config);

    auto const phasefield_parameters_config =
        //! \ogs_file_param{prj__processes__process__PHASE_FIELD__phasefield_parameters}
        config.getConfigSubtree("phasefield_parameters");

    // Residual stiffness
    auto const& residual_stiffness = ParameterLib::findParameter<double>(
        phasefield_parameters_config,
        //! \ogs_file_param_special{prj__processes__process__PHASE_FIELD__phasefield_parameters__residual_stiffness}
        "residual_stiffness", parameters, 1);
    DBUG("Use '{:s}' as residual stiffness.", residual_stiffness.name);

    // Crack resistance
    auto const& crack_resistance = ParameterLib::findParameter<double>(
        phasefield_parameters_config,
        //! \ogs_file_param_special{prj__processes__process__PHASE_FIELD__phasefield_parameters__crack_resistance}
        "crack_resistance", parameters, 1);
    DBUG("Use '{:s}' as crack resistance.", crack_resistance.name);

    // Crack length scale
    auto const& crack_length_scale = ParameterLib::findParameter<double>(
        phasefield_parameters_config,
        //! \ogs_file_param_special{prj__processes__process__PHASE_FIELD__phasefield_parameters__crack_length_scale}
        "crack_length_scale", parameters, 1);
    DBUG("Use '{:s}' as crack length scale.", crack_length_scale.name);

    // Characteristic_length
    auto const characteristic_length =
        //! \ogs_file_param{prj__processes__process__PHASE_FIELD__characteristic_length}
        config.getConfigParameter<double>("characteristic_length", 1.0);

    // Solid density
    auto const& solid_density = ParameterLib::findParameter<double>(
        config,
        //! \ogs_file_param_special{prj__processes__process__PHASE_FIELD__solid_density}
        "solid_density", parameters, 1);
    DBUG("Use '{:s}' as solid density parameter.", solid_density.name);

    // Specific body force
    Eigen::Matrix<double, DisplacementDim, 1> specific_body_force;
    {
        std::vector<double> const b =
            //! \ogs_file_param{prj__processes__process__PHASE_FIELD__specific_body_force}
            config.getConfigParameter<std::vector<double>>(
                "specific_body_force");
        if (b.size() != DisplacementDim)
        {
            OGS_FATAL(
                "The size of the specific body force vector does not match the "
                "displacement dimension. Vector size is {:d}, displacement "
                "dimension is {:d}",
                b.size(), DisplacementDim);
        }

        std::copy_n(b.data(), b.size(), specific_body_force.data());
    }

    auto const crack_scheme =
        //! \ogs_file_param{prj__processes__process__PHASE_FIELD__pressurized_crack_scheme}
        config.getConfigParameterOptional<std::string>("pressurized_crack_scheme");
    if (crack_scheme &&
        ((*crack_scheme != "propagating") && (*crack_scheme != "static")))
    {
        OGS_FATAL(
            "crack_scheme must be 'propagating' or 'static' but '{:s}' "
            "was given",
            crack_scheme->c_str());
    }

    const bool pressurized_crack = crack_scheme.has_value();
    const bool propagating_pressurized_crack = (crack_scheme && (*crack_scheme == "propagating"));
    const bool static_pressurized_crack = (crack_scheme && (*crack_scheme == "static"));

    auto const irreversible_threshold =
        //! \ogs_file_param{prj__processes__process__PHASE_FIELD__irreversible_threshold}
        config.getConfigParameter<double>("irreversible_threshold", 0.05);

    auto const phasefield_model = [&]
    {
        auto const phasefield_model_string =
            //! \ogs_file_param{prj__processes__process__PHASE_FIELD__phasefield_model}
            config.getConfigParameter<std::string>("phasefield_model");

        if (phasefield_model_string == "AT1")
        {
            return PhaseFieldModel::AT1;
        }
        if (phasefield_model_string == "AT2")
        {
            return PhaseFieldModel::AT2;
        }
        if (phasefield_model_string == "COHESIVE")
        {
            return PhaseFieldModel::COHESIVE;
        }
        OGS_FATAL(
            "phasefield_model must be 'AT1', 'AT2' or 'COHESIVE' but '{:s}' "
            "was given",
            phasefield_model_string.c_str());
    }();

    auto const softening_curve = [&]
    {
        auto const softening_curve_string =
            //! \ogs_file_param{prj__processes__process__PHASE_FIELD__softening_curve}
            config.getConfigParameterOptional<std::string>("softening_curve");
        if (softening_curve_string)
        {
            if (*softening_curve_string == "Linear")
            {
                return SofteningCurve::Linear;
            }
            if (*softening_curve_string == "Exponential")
            {
                return SofteningCurve::Exponential;
            }
            OGS_FATAL(
                "softening_curve must be 'Linear' or 'Exponential' but '{:s}' "
                "was given",
                softening_curve_string->c_str());
        }
        return SofteningCurve::Linear;  // default
    }();

    auto const energy_split_model = [&]
    {
        auto const energy_split_model_string =
            //! \ogs_file_param{prj__processes__process__PHASE_FIELD__energy_split_model}
            config.getConfigParameter<std::string>("energy_split_model");

        if (energy_split_model_string == "Isotropic")
        {
            return EnergySplitModel::Isotropic;
        }
        if (energy_split_model_string == "VolumetricDeviatoric")
        {
            return EnergySplitModel::VolDev;
        }
        if (energy_split_model_string == "EffectiveStress")
        {
            return EnergySplitModel::EffectiveStress;
        }
        if (energy_split_model_string == "OrthoVolDev")
        {
            return EnergySplitModel::OrthoVolDev;
        }
        if (energy_split_model_string == "OrthoMasonry")
        {
            return EnergySplitModel::OrthoMasonry;
        }
        OGS_FATAL(
            "energy_split_model must be 'Isotropic' or 'VolumetricDeviatoric' "
            "but '{:s}' was given",
            energy_split_model_string);
    }();

    std::unique_ptr<DegradationDerivative> degradation_derivative;
    if (phasefield_model == PhaseFieldModel::COHESIVE)
    {
        degradation_derivative =
            std::make_unique<COHESIVE_DegradationDerivative>(
                characteristic_length, softening_curve);
    }
    else
    {
        degradation_derivative = std::make_unique<AT_DegradationDerivative>();
    }

    PhaseFieldProcessData<DisplacementDim> process_data{
        materialIDs(mesh),
        std::move(solid_constitutive_relations),
        residual_stiffness,
        crack_resistance,
        crack_length_scale,
        solid_density,
        specific_body_force,
        pressurized_crack,
        propagating_pressurized_crack,
        static_pressurized_crack,
        irreversible_threshold,
        phasefield_model,
        energy_split_model,
        softening_curve,
        characteristic_length,
        std::move(degradation_derivative)};

    SecondaryVariableCollection secondary_variables;

    ProcessLib::createSecondaryVariables(config, secondary_variables);

    return std::make_unique<PhaseFieldProcess<DisplacementDim>>(
        std::move(name), mesh, std::move(jacobian_assembler), parameters,
        integration_order, std::move(process_variables),
        std::move(process_data), std::move(secondary_variables),
        use_monolithic_scheme);
}

template std::unique_ptr<Process> createPhaseFieldProcess<2>(
    std::string name,
    MeshLib::Mesh& mesh,
    std::unique_ptr<ProcessLib::AbstractJacobianAssembler>&& jacobian_assembler,
    std::vector<ProcessVariable> const& variables,
    std::vector<std::unique_ptr<ParameterLib::ParameterBase>> const& parameters,
    std::optional<ParameterLib::CoordinateSystem> const&
        local_coordinate_system,
    unsigned const integration_order,
    BaseLib::ConfigTree const& config);

template std::unique_ptr<Process> createPhaseFieldProcess<3>(
    std::string name,
    MeshLib::Mesh& mesh,
    std::unique_ptr<ProcessLib::AbstractJacobianAssembler>&& jacobian_assembler,
    std::vector<ProcessVariable> const& variables,
    std::vector<std::unique_ptr<ParameterLib::ParameterBase>> const& parameters,
    std::optional<ParameterLib::CoordinateSystem> const&
        local_coordinate_system,
    unsigned const integration_order,
    BaseLib::ConfigTree const& config);

}  // namespace PhaseField
}  // namespace ProcessLib