general_flow.h

#ifndef GENERAL_FLOW
#define GENERAL_FLOW

#include "objects.h"
#include "elasticity.h"
#include "visco_flow.h"

#include <cstddef>

namespace neml {

/// ABC for a completely general flow rule...
class GeneralFlowRule: public NEMLObject {
 public:
  /// Number of history variables
  virtual size_t nhist() const = 0;
  /// Initialize the history at time zero
  virtual int init_hist(double * const h) = 0;
  
  /// Stress rate
  virtual int s(const double * const s, const double * const alpha,
                const double * const edot, double T,
                double Tdot,
                double * const sdot) = 0;
  /// Partial of stress rate wrt stress
  virtual int ds_ds(const double * const s, const double * const alpha,
                const double * const edot, double T,
                double Tdot,
                double * const d_sdot) = 0;
  /// Partial of stress rate wrt history
  virtual int ds_da(const double * const s, const double * const alpha,
                const double * const edot, double T,
                double Tdot,
                double * const d_sdot) = 0;
  /// Partial of stress rate wrt strain rate
  virtual int ds_de(const double * const s, const double * const alpha,
                const double * const edot, double T,
                double Tdot,
                double * const d_sdot) = 0;
  
  /// History rate
  virtual int a(const double * const s, const double * const alpha,
                const double * const edot, double T,
                double Tdot,
                double * const adot) = 0;
  /// Partial of history rate wrt stress
  virtual int da_ds(const double * const s, const double * const alpha,
                const double * const edot, double T,
                double Tdot,
                double * const d_adot) = 0;
  /// Partial of history rate wrt history
  virtual int da_da(const double * const s, const double * const alpha,
                const double * const edot, double T,
                double Tdot,
                double * const d_adot) = 0;
  /// Partial of history rate wrt strain rate
  virtual int da_de(const double * const s, const double * const alpha,
                const double * const edot, double T,
                double Tdot,
                double * const d_adot) = 0;
  
  /// The implementation needs to define inelastic dissipation
  virtual int work_rate(const double * const s, const double * const alpha,
                const double * const edot, double T,
                double Tdot,
                double & p_rate);

  /// The implementation needs to define elastic strain
  virtual int elastic_strains(const double * const s_np1, double T_np1,
                              double * const e_np1) const = 0;

  /// Set a new elastic model
  virtual int set_elastic_model(std::shared_ptr<LinearElasticModel> emodel);
};

/// Thermo-visco-plasticity
//  Stress rates, temperature rates, and time can all enter the model
class TVPFlowRule : public GeneralFlowRule {
 public:
  /// Parameters: elastic model and a viscoplastic flow rule
  TVPFlowRule(std::shared_ptr<LinearElasticModel> elastic,
              std::shared_ptr<ViscoPlasticFlowRule> flow);
  
  /// String type for the object system
  static std::string type();
  /// Return default parameters
  static std::unique_ptr<NEMLObject> initialize(ParameterSet & params);
  /// Initialize from parameter set
  static ParameterSet parameters();
  
  /// Number of history variables
  virtual size_t nhist() const;
  /// Initialize history
  virtual int init_hist(double * const h);

  /// Stress rate
  virtual int s(const double * const s, const double * const alpha,
                const double * const edot, double T,
                double Tdot,
                double * const sdot);
  /// Partial of stress rate wrt stress
  virtual int ds_ds(const double * const s, const double * const alpha,
                const double * const edot, double T,
                double Tdot,
                double * const d_sdot);
  /// Partial of stress rate wrt history
  virtual int ds_da(const double * const s, const double * const alpha,
                const double * const edot, double T,
                double Tdot,
                double * const d_sdot);
  /// Partial of stress rate wrt strain rate
  virtual int ds_de(const double * const s, const double * const alpha,
                const double * const edot, double T,
                double Tdot,
                double * const d_sdot);
  
  /// History rate
  virtual int a(const double * const s, const double * const alpha,
                const double * const edot, double T,
                double Tdot,
                double * const adot);
  /// Partial of history rate wrt stress
  virtual int da_ds(const double * const s, const double * const alpha,
                const double * const edot, double T,
                double Tdot,
                double * const d_adot);
  /// Partial of history rate wrt history
  virtual int da_da(const double * const s, const double * const alpha,
                const double * const edot, double T,
                double Tdot,
                double * const d_adot);
  /// Partial of history rate wrt strain rate
  virtual int da_de(const double * const s, const double * const alpha,
                const double * const edot, double T,
                double Tdot,
                double * const d_adot);
  
  /// The implementation needs to define inelastic dissipation
  virtual int work_rate(const double * const s, const double * const alpha,
                const double * const edot, double T,
                double Tdot,
                double & p_rate);

  /// The implementation needs to define elastic strain
  virtual int elastic_strains(const double * const s_np1, double T_np1,
                              double * const e_np1) const;

  /// Set a new elastic model
  virtual int set_elastic_model(std::shared_ptr<LinearElasticModel> emodel);
  
 private:
  std::shared_ptr<LinearElasticModel> elastic_;
  std::shared_ptr<ViscoPlasticFlowRule> flow_;
};

static Register<TVPFlowRule> regTVPFlowRule;

} // namespace neml

#endif