NEML2 2.0.0
All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Modules Pages
NonlinearParameter Struct Reference

Nonlinear parameter. More...

Detailed Description

Nonlinear parameter.

The word "nonlinear" refers to the fact that the parameter can change as a function of state or forces. In other words, in the context of updating an implicit model, the value of the parameter can change fron nonlinear iteration to nonlinear iteration, as the guess of the solution keeps updating.

The output of a nonlinear parameter is not a "parameter" in our usual definition as one does not calibrate or optimize the nonlinear parameter in a training loop. However, the definition of the nonlinear parameter itself is oftentimes parameterized on a set of parameters (in the canonical definition). Those parameters can be calibrated or optimized.

#include <NonlinearParameter.h>

Public Attributes

Modelprovider = nullptr
 The model that defines this parameter.
 
VariableName provider_var
 The variable name of the model that defines this parameter.
 
const VariableBasevalue = nullptr
 The actual parameter value.
 

Member Data Documentation

◆ provider

Model* provider = nullptr

The model that defines this parameter.

◆ provider_var

VariableName provider_var

The variable name of the model that defines this parameter.

◆ value

const VariableBase* value = nullptr

The actual parameter value.