www.mooseframework.org
Public Member Functions | Protected Attributes | List of all members
OrderParameterFunctionMaterial Class Reference

Material base class for materials that provide the switching function \( h(\eta) \) or the double well function \( g(\eta) \). More...

#include <OrderParameterFunctionMaterial.h>

Inheritance diagram for OrderParameterFunctionMaterial:
[legend]

Public Member Functions

 OrderParameterFunctionMaterial (const InputParameters &parameters)
 

Protected Attributes

const VariableValue & _eta
 Coupled variable value for the order parameter \( \eta \). More...
 
unsigned int _eta_var
 
VariableName _eta_name
 
std::string _function_name
 name of the function of eta (used to generate the material property names) More...
 
MaterialProperty< Real > & _prop_f
 Material property to store \( f(\eta) \). More...
 
MaterialProperty< Real > & _prop_df
 Material property to store the derivative \( df(\eta)/d\eta \). More...
 
MaterialProperty< Real > & _prop_d2f
 Material property to store the second derivative \( d^2f(\eta)/d\eta^2 \). More...
 

Detailed Description

Material base class for materials that provide the switching function \( h(\eta) \) or the double well function \( g(\eta) \).

Implement computeQpProperties in the derived classes.

Definition at line 24 of file OrderParameterFunctionMaterial.h.

Constructor & Destructor Documentation

OrderParameterFunctionMaterial::OrderParameterFunctionMaterial ( const InputParameters &  parameters)

Definition at line 19 of file OrderParameterFunctionMaterial.C.

20  : DerivativeMaterialInterface<Material>(parameters),
21  _eta(coupledValue("eta")),
22  _eta_var(coupled("eta")),
23  _eta_name(getVar("eta", 0)->name()),
24  _function_name(getParam<std::string>("function_name")),
25  _prop_f(declareProperty<Real>(_function_name)),
26  _prop_df(declarePropertyDerivative<Real>(_function_name, _eta_name)),
27  _prop_d2f(declarePropertyDerivative<Real>(_function_name, _eta_name, _eta_name))
28 {
29 }
MaterialProperty< Real > & _prop_d2f
Material property to store the second derivative .
std::string _function_name
name of the function of eta (used to generate the material property names)
MaterialProperty< Real > & _prop_df
Material property to store the derivative .
MaterialProperty< Real > & _prop_f
Material property to store .
const VariableValue & _eta
Coupled variable value for the order parameter .

Member Data Documentation

const VariableValue& OrderParameterFunctionMaterial::_eta
protected
VariableName OrderParameterFunctionMaterial::_eta_name
protected

Definition at line 33 of file OrderParameterFunctionMaterial.h.

unsigned int OrderParameterFunctionMaterial::_eta_var
protected

Definition at line 32 of file OrderParameterFunctionMaterial.h.

std::string OrderParameterFunctionMaterial::_function_name
protected

name of the function of eta (used to generate the material property names)

Definition at line 36 of file OrderParameterFunctionMaterial.h.

MaterialProperty<Real>& OrderParameterFunctionMaterial::_prop_d2f
protected

Material property to store the second derivative \( d^2f(\eta)/d\eta^2 \).

Definition at line 45 of file OrderParameterFunctionMaterial.h.

Referenced by BarrierFunctionMaterial::computeQpProperties(), SwitchingFunctionMaterial::computeQpProperties(), and MixedSwitchingFunctionMaterial::computeQpProperties().

MaterialProperty<Real>& OrderParameterFunctionMaterial::_prop_df
protected
MaterialProperty<Real>& OrderParameterFunctionMaterial::_prop_f
protected

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