www.mooseframework.org
OrderParameterFunctionMaterial.h
Go to the documentation of this file.
1 //* This file is part of the MOOSE framework
2 //* https://www.mooseframework.org
3 //*
4 //* All rights reserved, see COPYRIGHT for full restrictions
5 //* https://github.com/idaholab/moose/blob/master/COPYRIGHT
6 //*
7 //* Licensed under LGPL 2.1, please see LICENSE for details
8 //* https://www.gnu.org/licenses/lgpl-2.1.html
9 
10 #pragma once
11 
12 #include "Material.h"
13 #include "DerivativeMaterialInterface.h"
14 
15 // Forward Declarations
17 
18 template <>
20 
26 class OrderParameterFunctionMaterial : public DerivativeMaterialInterface<Material>
27 {
28 public:
29  OrderParameterFunctionMaterial(const InputParameters & parameters);
30 
31 protected:
33  const VariableValue & _eta;
34  unsigned int _eta_var;
35  VariableName _eta_name;
36 
38  std::string _function_name;
39 
41  MaterialProperty<Real> & _prop_f;
42 
44  MaterialProperty<Real> & _prop_df;
45 
47  MaterialProperty<Real> & _prop_d2f;
48 };
49 
OrderParameterFunctionMaterial::_prop_f
MaterialProperty< Real > & _prop_f
Material property to store .
Definition: OrderParameterFunctionMaterial.h:41
OrderParameterFunctionMaterial
Material base class for materials that provide the switching function or the double well function .
Definition: OrderParameterFunctionMaterial.h:26
OrderParameterFunctionMaterial::_function_name
std::string _function_name
name of the function of eta (used to generate the material property names)
Definition: OrderParameterFunctionMaterial.h:38
OrderParameterFunctionMaterial::_eta
const VariableValue & _eta
Coupled variable value for the order parameter .
Definition: OrderParameterFunctionMaterial.h:33
OrderParameterFunctionMaterial::_eta_name
VariableName _eta_name
Definition: OrderParameterFunctionMaterial.h:35
validParams< OrderParameterFunctionMaterial >
InputParameters validParams< OrderParameterFunctionMaterial >()
Definition: OrderParameterFunctionMaterial.C:14
OrderParameterFunctionMaterial::OrderParameterFunctionMaterial
OrderParameterFunctionMaterial(const InputParameters &parameters)
Definition: OrderParameterFunctionMaterial.C:22
OrderParameterFunctionMaterial::_eta_var
unsigned int _eta_var
Definition: OrderParameterFunctionMaterial.h:34
OrderParameterFunctionMaterial::_prop_df
MaterialProperty< Real > & _prop_df
Material property to store the derivative .
Definition: OrderParameterFunctionMaterial.h:44
OrderParameterFunctionMaterial::_prop_d2f
MaterialProperty< Real > & _prop_d2f
Material property to store the second derivative .
Definition: OrderParameterFunctionMaterial.h:47