MOOSEToNEML2.h

Go to the documentation of this file.

//* This file is part of the MOOSE framework
//* https://mooseframework.inl.gov
//*
//* All rights reserved, see COPYRIGHT for full restrictions
//* https://github.com/idaholab/moose/blob/master/COPYRIGHT
//*
//* Licensed under LGPL 2.1, please see LICENSE for details
//* https://www.gnu.org/licenses/lgpl-2.1.html

#pragma once

#include "NEML2Utils.h"
#include "InputParameters.h"

#ifdef NEML2_ENABLED
#include "neml2/models/Model.h"
#endif

class MOOSEToNEML2
{
public:
  static InputParameters validParams();

  MOOSEToNEML2(const InputParameters & params);

#ifdef NEML2_ENABLED
  enum class Mode
  {
    VARIABLE,
    OLD_VARIABLE,
    PARAMETER,
    UNDEFINED
  };

  void setMode(Mode) const;

  Mode getMode() const { return _mode; }

  virtual void checkMode() const;

  const std::string & NEML2Name() const { return _raw_name; }

  const neml2::VariableName & NEML2VariableName() const;

  const std::string & NEML2ParameterName() const;

  virtual neml2::Tensor gatheredData() const = 0;

  void insertInto(neml2::ValueMap &, std::map<std::string, neml2::Tensor> &) const;

protected:
  mutable Mode _mode;

  mutable neml2::VariableName _neml2_variable;

  mutable std::string _neml2_parameter;

private:
  const std::string _raw_name;
#endif
};