Sets up variables and Kernels to test the derivatives of material properties via the Jacobian checker. More...

#include <MaterialDerivativeTestAction.h>

Inheritance diagram for MaterialDerivativeTestAction:

Public Types
typedef DataFileName	DataFileParameterType

typedef std::string	SymbolName

Public Member Functions
	MaterialDerivativeTestAction (const InputParameters &parameters)

virtual void	act () override

void	timedAct ()

virtual void	addRelationshipManagers (Moose::RelationshipManagerType when_type)

MooseObjectName	uniqueActionName () const

const std::string &	specificTaskName () const

const std::set< std::string > &	getAllTasks () const

void	appendTask (const std::string &task)

MooseApp &	getMooseApp () const

const std::string &	type () const

const std::string &	name () const

std::string	typeAndName () const

MooseObjectParameterName	uniqueParameterName (const std::string &parameter_name) const

MooseObjectName	uniqueName () const

const InputParameters &	parameters () const

const hit::Node *	getHitNode () const

bool	hasBase () const

const std::string &	getBase () const

const T &	getParam (const std::string &name) const

std::vector< std::pair< T1, T2 > >	getParam (const std::string &param1, const std::string &param2) const

const T *	queryParam (const std::string &name) const

const T &	getRenamedParam (const std::string &old_name, const std::string &new_name) const

T	getCheckedPointerParam (const std::string &name, const std::string &error_string="") const

bool	isParamValid (const std::string &name) const

bool	isParamSetByUser (const std::string &name) const

void	connectControllableParams (const std::string &parameter, const std::string &object_type, const std::string &object_name, const std::string &object_parameter) const

void	paramError (const std::string &param, Args... args) const

void	paramWarning (const std::string &param, Args... args) const

void	paramWarning (const std::string &param, Args... args) const

void	paramInfo (const std::string &param, Args... args) const

std::string	messagePrefix (const bool hit_prefix=true) const

std::string	errorPrefix (const std::string &) const

void	mooseError (Args &&... args) const

void	mooseDocumentedError (const std::string &repo_name, const unsigned int issue_num, Args &&... args) const

void	mooseErrorNonPrefixed (Args &&... args) const

void	mooseWarning (Args &&... args) const

void	mooseWarning (Args &&... args) const

void	mooseWarningNonPrefixed (Args &&... args) const

void	mooseWarningNonPrefixed (Args &&... args) const

void	mooseDeprecated (Args &&... args) const

void	mooseDeprecated (Args &&... args) const

void	mooseDeprecatedNoTrace (Args &&... args) const

void	mooseInfo (Args &&... args) const

void	callMooseError (std::string msg, const bool with_prefix, const hit::Node *node=nullptr, const bool show_trace=true) const

std::string	getDataFileName (const std::string &param) const

std::string	getDataFileNameByName (const std::string &relative_path) const

std::string	getDataFilePath (const std::string &relative_path) const

PerfGraph &	perfGraph ()

const Parallel::Communicator &	comm () const

processor_id_type	n_processors () const

processor_id_type	processor_id () const

const MaterialPropertyName	derivativePropertyName (const MaterialPropertyName &base, const std::vector< SymbolName > &c) const

const MaterialPropertyName	derivativePropertyNameFirst (const MaterialPropertyName &base, const SymbolName &c1) const

const MaterialPropertyName	derivativePropertyNameSecond (const MaterialPropertyName &base, const SymbolName &c1, const SymbolName &c2) const

const MaterialPropertyName	derivativePropertyNameThird (const MaterialPropertyName &base, const SymbolName &c1, const SymbolName &c2, const SymbolName &c3) const

const MaterialPropertyName	propertyName (const MaterialPropertyName &base, const std::vector< SymbolName > &c) const

const MaterialPropertyName	propertyName (const MaterialPropertyName &base, const std::vector< SymbolName > &c) const

const MaterialPropertyName	propertyNameFirst (const MaterialPropertyName &base, const SymbolName &c1) const

const MaterialPropertyName	propertyNameFirst (const MaterialPropertyName &base, const SymbolName &c1) const

const MaterialPropertyName	propertyNameSecond (const MaterialPropertyName &base, const SymbolName &c1, const SymbolName &c2) const

const MaterialPropertyName	propertyNameSecond (const MaterialPropertyName &base, const SymbolName &c1, const SymbolName &c2) const

const MaterialPropertyName	propertyNameThird (const MaterialPropertyName &base, const SymbolName &c1, const SymbolName &c2, const SymbolName &c3) const

const MaterialPropertyName	propertyNameThird (const MaterialPropertyName &base, const SymbolName &c1, const SymbolName &c2, const SymbolName &c3) const

Static Public Member Functions
static InputParameters	validParams ()

static void	callMooseError (MooseApp const app, const InputParameters &params, std::string msg, const bool with_prefix, const hit::Node node, const bool show_trace=true)

Public Attributes
	usingCombinedWarningSolutionWarnings

const ConsoleStream	_console

Static Public Attributes
static const std::string	unique_action_name_param

static const std::string	type_param

static const std::string	name_param

static const std::string	unique_name_param

static const std::string	app_param

static const std::string	moose_base_param

static const std::string	kokkos_object_param

static constexpr auto	SYSTEM

static constexpr auto	NAME

Protected Types
enum class	PropTypeEnum { REAL , RANKTWOTENSOR , RANKFOURTENSOR }

Protected Member Functions
bool	addRelationshipManagers (Moose::RelationshipManagerType when_type, const InputParameters &moose_object_pars)

void	associateWithParameter (const std::string &param_name, InputParameters &params) const

void	associateWithParameter (const InputParameters &from_params, const std::string &param_name, InputParameters &params) const

const T &	getMeshProperty (const std::string &data_name, const std::string &prefix)

const T &	getMeshProperty (const std::string &data_name)

bool	hasMeshProperty (const std::string &data_name, const std::string &prefix) const

bool	hasMeshProperty (const std::string &data_name, const std::string &prefix) const

bool	hasMeshProperty (const std::string &data_name) const

bool	hasMeshProperty (const std::string &data_name) const

std::string	meshPropertyName (const std::string &data_name) const

PerfID	registerTimedSection (const std::string &section_name, const unsigned int level) const

PerfID	registerTimedSection (const std::string &section_name, const unsigned int level, const std::string &live_message, const bool print_dots=true) const

std::string	timedSectionName (const std::string &section_name) const

void	flagInvalidSolutionInternal (const InvalidSolutionID invalid_solution_id) const

InvalidSolutionID	registerInvalidSolutionInternal (const std::string &message, const bool warning) const

Static Protected Member Functions
static std::string	meshPropertyName (const std::string &data_name, const std::string &prefix)

Protected Attributes
std::vector< VariableName >	_args

MaterialPropertyName	_prop_name

enum MaterialDerivativeTestAction::PropTypeEnum	_prop_type

const unsigned int	_derivative_order

const bool	_second

std::map< MaterialPropertyName, std::vector< SymbolName > >	_derivatives
	every derivative given by a list of variables to derive w.r.t

std::string	_registered_identifier

std::string	_specific_task_name

std::set< std::string >	_all_tasks

ActionWarehouse &	_awh

const std::string &	_current_task

std::shared_ptr< MooseMesh > &	_mesh

std::shared_ptr< MooseMesh > &	_displaced_mesh

std::shared_ptr< FEProblemBase > &	_problem

PerfID	_act_timer

MooseApp &	_app

Factory &	_factory

ActionFactory &	_action_factory

const std::string &	_type

const std::string &	_name

const InputParameters &	_pars

MooseApp &	_pg_moose_app

const std::string	_prefix

const Parallel::Communicator &	_communicator

Private Member Functions
bool	addRelationshipManager (Moose::RelationshipManagerType input_rm_type, const InputParameters &moose_object_pars, std::string rm_name, Moose::RelationshipManagerType rm_type, Moose::RelationshipManagerInputParameterCallback rm_input_parameter_func, Moose::RMSystemType sys_type=Moose::RMSystemType::NONE)

virtual std::string	meshPropertyPrefix (const std::string &data_name) const

const RestartableDataValue &	getMeshPropertyInternal (const std::string &data_name, const std::string &prefix) const

void	mooseErrorInternal (Args &&... args) const

Static Private Member Functions
static const hit::Node *	getHitNode (const InputParameters &params)

static std::string	messagePrefix (const InputParameters &params, const bool hit_prefix)

Private Attributes
const ParallelParamObject &	_parent

MooseApp &	_meta_data_app

const MooseObject *const	_meta_data_object

const MooseBase &	_si_moose_base

const FEProblemBase *	_si_problem

Detailed Description

Sets up variables and Kernels to test the derivatives of material properties via the Jacobian checker.

Definition at line 19 of file MaterialDerivativeTestAction.h.

Member Enumeration Documentation

◆ PropTypeEnum

enum class MaterialDerivativeTestAction::PropTypeEnum

strongprotected

Enumerator
REAL
RANKTWOTENSOR
RANKFOURTENSOR

Definition at line 33 of file MaterialDerivativeTestAction.h.

  {
    REAL,
    RANKTWOTENSOR,
    RANKFOURTENSOR
  } _prop_type;

Constructor & Destructor Documentation

◆ MaterialDerivativeTestAction()

MaterialDerivativeTestAction::MaterialDerivativeTestAction ( const InputParameters & parameters )

Definition at line 44 of file MaterialDerivativeTestAction.C.

  : Action(parameters),
    _args(getParam<std::vector<VariableName>>("args")),
    _prop_name(getParam<MaterialPropertyName>("prop_name")),
    _prop_type(getParam<MooseEnum>("prop_type").getEnum<PropTypeEnum>()),
    _derivative_order(getParam<unsigned int>("derivative_order")),
    _second(false),
    _derivatives({{_prop_name, {}}})
{
  std::vector<std::vector<std::vector<SymbolName>>> derivative_table(_derivative_order + 1);
 
  // 0th derivative is a (single) derivative w.r.t. to _no_ variables
  derivative_table[0] = {{}};
 
  // build higher order derivatives
  for (unsigned int n = 1; n <= _derivative_order; ++n)
    for (const auto & function : derivative_table[n - 1])
      for (const auto & var : _args)
      {
        // take previous order derivative and derive w.r.t. one of the args
        auto derivative = std::vector<SymbolName>(function);
        derivative.push_back(var);
 
        // add derivative to list
        derivative_table[n].push_back(derivative);
        _derivatives.insert(
            std::make_pair(derivativePropertyName(_prop_name, derivative), derivative));
      }
}

Member Function Documentation

◆ act()

void MaterialDerivativeTestAction::act ( )

overridevirtual

Implements Action.

Definition at line 75 of file MaterialDerivativeTestAction.C.

{
  // finite element type
  const std::string order = _second ? "SECOND" : "FIRST";
  const std::string family("LAGRANGE");
  const auto type = "MooseVariable";
  auto params = _factory.getValidParams(type);
  params.set<MooseEnum>("order") = order;
  params.set<MooseEnum>("family") = family;
 
  // build higher order derivatives
  for (const auto & derivative : _derivatives)
  {
    // Create variables
    if (_current_task == "add_variable")
    {
      switch (_prop_type)
      {
        case PropTypeEnum::REAL:
          _problem->addVariable(type, "var_" + derivative.first, params);
          break;
 
        case PropTypeEnum::RANKTWOTENSOR:
          for (unsigned int i = 0; i < 3; ++i)
            for (unsigned int j = 0; j < 3; ++j)
              _problem->addVariable(type,
                                    "var_" + derivative.first + '_' + Moose::stringify(i) + '_' +
                                        Moose::stringify(j),
                                    params);
          break;
 
        case PropTypeEnum::RANKFOURTENSOR:
          for (unsigned int i = 0; i < 3; ++i)
            for (unsigned int j = 0; j < 3; ++j)
              for (unsigned int k = 0; k < 3; ++k)
                for (unsigned int l = 0; l < 3; ++l)
                  _problem->addVariable(type,
                                        "var_" + derivative.first + '_' + Moose::stringify(i) +
                                            '_' + Moose::stringify(j) + '_' + Moose::stringify(k) +
                                            '_' + Moose::stringify(l),
                                        params);
          break;
 
        default:
          mooseError("Unknown property type.");
      }
    }
 
    if (_current_task == "add_kernel")
    {
      switch (_prop_type)
      {
        case PropTypeEnum::REAL:
        {
          auto params = _factory.getValidParams("MaterialDerivativeTestKernel");
          params.set<std::vector<VariableName>>("coupled_variables") = _args;
          params.set<std::vector<SymbolName>>("derivative") = derivative.second;
          params.set<MaterialPropertyName>("material_property") = _prop_name;
          params.set<NonlinearVariableName>("variable") = "var_" + derivative.first;
          _problem->addKernel("MaterialDerivativeTestKernel", "kernel_" + derivative.first, params);
          break;
        }
 
        case PropTypeEnum::RANKTWOTENSOR:
        {
          auto params = _factory.getValidParams("MaterialDerivativeRankTwoTestKernel");
          params.set<std::vector<VariableName>>("coupled_variables") = _args;
          params.set<std::vector<SymbolName>>("derivative") = derivative.second;
          params.set<MaterialPropertyName>("material_property") = _prop_name;
          for (unsigned int i = 0; i < 3; ++i)
            for (unsigned int j = 0; j < 3; ++j)
            {
              auto suffix =
                  derivative.first + '_' + Moose::stringify(i) + '_' + Moose::stringify(j);
              params.set<NonlinearVariableName>("variable") = "var_" + suffix;
              params.set<unsigned int>("i") = i;
              params.set<unsigned int>("j") = j;
              _problem->addKernel(
                  "MaterialDerivativeRankTwoTestKernel", "kernel_" + suffix, params);
            }
          break;
        }
 
        case PropTypeEnum::RANKFOURTENSOR:
        {
          auto params = _factory.getValidParams("MaterialDerivativeRankFourTestKernel");
          params.set<std::vector<VariableName>>("coupled_variables") = _args;
          params.set<std::vector<SymbolName>>("derivative") = derivative.second;
          params.set<MaterialPropertyName>("material_property") = _prop_name;
          for (unsigned int i = 0; i < 3; ++i)
            for (unsigned int j = 0; j < 3; ++j)
              for (unsigned int k = 0; k < 3; ++k)
                for (unsigned int l = 0; l < 3; ++l)
                {
                  auto suffix = derivative.first + '_' + Moose::stringify(i) + '_' +
                                Moose::stringify(j) + '_' + Moose::stringify(k) + '_' +
                                Moose::stringify(l);
                  params.set<NonlinearVariableName>("variable") = "var_" + suffix;
                  params.set<unsigned int>("i") = i;
                  params.set<unsigned int>("j") = j;
                  params.set<unsigned int>("k") = k;
                  params.set<unsigned int>("l") = l;
                  _problem->addKernel(
                      "MaterialDerivativeRankFourTestKernel", "kernel_" + suffix, params);
                }
          break;
        }
 
        default:
          mooseError("Unknown property type.");
      }
    }
  }
 
  if (_current_task == "add_preconditioning")
  {
    auto params = _factory.getValidParams("SMP");
    auto & row = params.set<std::vector<NonlinearVariableName>>("off_diag_row");
    auto & col = params.set<std::vector<NonlinearVariableName>>("off_diag_column");
 
    for (const auto & derivative : _derivatives)
    {
      switch (_prop_type)
      {
        case PropTypeEnum::REAL:
          for (auto & arg : _args)
          {
            row.push_back("var_" + derivative.first);
            col.push_back(arg);
          }
          break;
 
        case PropTypeEnum::RANKTWOTENSOR:
          for (unsigned int i = 0; i < 3; ++i)
            for (unsigned int j = 0; j < 3; ++j)
              for (auto & arg : _args)
              {
                row.push_back("var_" + derivative.first + '_' + Moose::stringify(i) + '_' +
                              Moose::stringify(j));
                col.push_back(arg);
              }
          break;
 
        case PropTypeEnum::RANKFOURTENSOR:
          for (unsigned int i = 0; i < 3; ++i)
            for (unsigned int j = 0; j < 3; ++j)
              for (unsigned int k = 0; k < 3; ++k)
                for (unsigned int l = 0; l < 3; ++l)
                  for (auto & arg : _args)
                  {
                    row.push_back("var_" + derivative.first + '_' + Moose::stringify(i) + '_' +
                                  Moose::stringify(j) + '_' + Moose::stringify(k) + '_' +
                                  Moose::stringify(l));
                    col.push_back(arg);
                  }
          break;
 
        default:
          mooseError("Unknown property type.");
      }
    }
 
    if (_problem.get() != nullptr)
    {
      std::shared_ptr<MoosePreconditioner> pc =
          _factory.create<MoosePreconditioner>("SMP", "material_derivative_SMP", params);
 
      _problem->getNonlinearSystemBase(/*nl_sys=*/0).setPreconditioner(pc);
    }
    else
      mooseError("_problem.get() returned nullptr");
  }
}

◆ validParams()

InputParameters MaterialDerivativeTestAction::validParams ( )

static

Definition at line 27 of file MaterialDerivativeTestAction.C.

{
  InputParameters params = Action::validParams();
  params.addClassDescription(
      "Action for setting up the necessary objects for debugging material property derivatives.");
  params.addParam<std::vector<VariableName>>("args",
                                             "Variables the tested material property depends on.");
  params.addRequiredParam<MaterialPropertyName>(
      "prop_name", "Name of the material property to test the derivatives of.");
  MooseEnum prop_type_enum("Real RankTwoTensor RankFourTensor");
  params.addParam<MooseEnum>(
      "prop_type", prop_type_enum, "Type of the material property to test the derivatives of.");
  params.addParam<unsigned int>(
      "derivative_order", 0, "Highest order derivative to test derivatives of.");
  return params;
}

Member Data Documentation

◆ _args

std::vector<VariableName> MaterialDerivativeTestAction::_args

protected

Definition at line 29 of file MaterialDerivativeTestAction.h.

Referenced by act().

◆ _derivative_order

const unsigned int MaterialDerivativeTestAction::_derivative_order

protected

Definition at line 40 of file MaterialDerivativeTestAction.h.

◆ _derivatives

std::map<MaterialPropertyName, std::vector<SymbolName> > MaterialDerivativeTestAction::_derivatives

protected

every derivative given by a list of variables to derive w.r.t

Definition at line 45 of file MaterialDerivativeTestAction.h.

Referenced by act().

◆ _prop_name

MaterialPropertyName MaterialDerivativeTestAction::_prop_name

protected

Definition at line 31 of file MaterialDerivativeTestAction.h.

Referenced by act(), and MaterialDerivativeTestAction().

◆ _prop_type

enum MaterialDerivativeTestAction::PropTypeEnum MaterialDerivativeTestAction::_prop_type

protected

Referenced by act().

◆ _second

const bool MaterialDerivativeTestAction::_second

protected

Definition at line 42 of file MaterialDerivativeTestAction.h.

Referenced by act().

The documentation for this class was generated from the following files:

combined/test/include/actions/MaterialDerivativeTestAction.h
combined/test/src/actions/MaterialDerivativeTestAction.C

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Protected Types

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Private Member Functions

Static Private Member Functions

Private Attributes

Detailed Description

Member Enumeration Documentation

◆ PropTypeEnum

Constructor & Destructor Documentation

◆ MaterialDerivativeTestAction()

Member Function Documentation

◆ act()

◆ validParams()

Member Data Documentation

◆ _args

◆ _derivative_order

◆ _derivatives

◆ _prop_name

◆ _prop_type

◆ _second