doxygen/moose/MOOSEToNEML2_8h_source.html

//* 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

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


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


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


private:

  const std::string _neml2_name;

#endif

};


InputParameters.h

NEML2Utils.h

InputParameters
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system.
Definition InputParameters.h:68

MOOSEToNEML2
Common interface for inserting gathered MOOSE data into the NEML2 material model.
Definition MOOSEToNEML2.h:29

MOOSEToNEML2::_neml2_name
const std::string _neml2_name
Name of the input variable or model parameter.
Definition MOOSEToNEML2.h:47

MOOSEToNEML2::validParams
static InputParameters validParams()
Definition MOOSEToNEML2.C:13

MOOSEToNEML2::gatheredData
virtual neml2::Tensor gatheredData() const =0
Convert data gathered from MOOSE into neml2::Tensor.

MOOSEToNEML2::insertInto
void insertInto(std::map< std::string, neml2::Tensor > &) const
Insert the gathered data into the NEML2 material model.
Definition MOOSEToNEML2.C:34

MOOSEToNEML2::NEML2Name
const std::string & NEML2Name() const
Name of the NEML2 variable/parameter.
Definition MOOSEToNEML2.h:37