CrossTermBarrierFunctionMaterial

Free energy contribution symmetric across interfaces between arbitrary pairs of phases.

The material provides a function $var element = document.getElementById("moose-equation-cedf3529-6cf6-4245-9280-ae970f5e9c5c");katex.render("g(\\vec\\eta)", element, {displayMode:false,throwOnError:false,macros:{"\\pf":"\\frac{\\partial #1}{\\partial #2}"}});$ that is parameterized by all phase order parameters $var element = document.getElementById("moose-equation-2e051c54-2d39-4fdd-9089-3e935edd3f76");katex.render("\\eta", element, {displayMode:false,throwOnError:false,macros:{"\\pf":"\\frac{\\partial #1}{\\partial #2}"}});$ . It calculates a phase transformation barrier energy that contains contributions for pairs of order parameters.

With the g_order parameter set to SIMPLE the function is defined as

$var element = document.getElementById("moose-equation-5adaed43-ad24-4ae1-8356-84edf378f1c5");katex.render("g(\\vec\\eta) = 16\\sum_i\\sum_{j>i} W_{ij} \\eta_i^2\\eta_j^2", element, {displayMode:true,throwOnError:false,macros:{"\\pf":"\\frac{\\partial #1}{\\partial #2}"}});$

and with the g_order parameter set to LOW it is defined as

$var element = document.getElementById("moose-equation-331280f1-fb70-4d9e-9adf-6cec8109d797");katex.render("g(\\vec\\eta) = 16\\sum_i\\sum_{j>i} W_{ij} \\eta_i\\eta_j", element, {displayMode:true,throwOnError:false,macros:{"\\pf":"\\frac{\\partial #1}{\\partial #2}"}});$

The $var element = document.getElementById("moose-equation-e69addce-d7eb-4757-8ce1-bbf566b7d38f");katex.render("W_{ij}", element, {displayMode:false,throwOnError:false,macros:{"\\pf":"\\frac{\\partial #1}{\\partial #2}"}});$ is a matrix of all coefficients for the pair terms.

Input Parameters

W_ijTerms controlling barrier height set W=1 in DerivativeMultiPhaseMaterial for these to apply
C++ Type:std::vector
Options:
Description:Terms controlling barrier height set W=1 in DerivativeMultiPhaseMaterial for these to apply
etaseta_i order parameters, one for each h
C++ Type:std::vector
Options:
Description:eta_i order parameters, one for each h

Required Parameters

blockThe list of block ids (SubdomainID) that this object will be applied
C++ Type:std::vector
Options:
Description:The list of block ids (SubdomainID) that this object will be applied
boundaryThe list of boundary IDs from the mesh where this boundary condition applies
C++ Type:std::vector
Options:
Description:The list of boundary IDs from the mesh where this boundary condition applies
computeTrueWhen false, MOOSE will not call compute methods on this material. The user must call computeProperties() after retrieving the MaterialBase via MaterialBasePropertyInterface::getMaterialBase(). Non-computed MaterialBases are not sorted for dependencies.
Default:True
C++ Type:bool
Options:
Description:When false, MOOSE will not call compute methods on this material. The user must call computeProperties() after retrieving the MaterialBase via MaterialBasePropertyInterface::getMaterialBase(). Non-computed MaterialBases are not sorted for dependencies.
constant_onNONEWhen ELEMENT, MOOSE will only call computeQpProperties() for the 0th quadrature point, and then copy that value to the other qps.When SUBDOMAIN, MOOSE will only call computeSubdomainProperties() for the 0th quadrature point, and then copy that value to the other qps. Evaluations on element qps will be skipped
Default:NONE
C++ Type:MooseEnum
Options:NONE ELEMENT SUBDOMAIN
Description:When ELEMENT, MOOSE will only call computeQpProperties() for the 0th quadrature point, and then copy that value to the other qps.When SUBDOMAIN, MOOSE will only call computeSubdomainProperties() for the 0th quadrature point, and then copy that value to the other qps. Evaluations on element qps will be skipped
function_namegactual name for g(eta_i)
Default:g
C++ Type:std::string
Options:
Description:actual name for g(eta_i)
g_orderSIMPLEPolynomial order of the barrier function g(eta)
Default:SIMPLE
C++ Type:MooseEnum
Options:SIMPLE LOW
Description:Polynomial order of the barrier function g(eta)

Optional Parameters

control_tagsAdds user-defined labels for accessing object parameters via control logic.
C++ Type:std::vector
Options:
Description:Adds user-defined labels for accessing object parameters via control logic.
enableTrueSet the enabled status of the MooseObject.
Default:True
C++ Type:bool
Options:
Description:Set the enabled status of the MooseObject.
implicitTrueDetermines whether this object is calculated using an implicit or explicit form
Default:True
C++ Type:bool
Options:
Description:Determines whether this object is calculated using an implicit or explicit form
seed0The seed for the master random number generator
Default:0
C++ Type:unsigned int
Options:
Description:The seed for the master random number generator
use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
Default:False
C++ Type:bool
Options:
Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

Advanced Parameters

output_propertiesList of material properties, from this material, to output (outputs must also be defined to an output type)
C++ Type:std::vector
Options:
Description:List of material properties, from this material, to output (outputs must also be defined to an output type)
outputsnone Vector of output names were you would like to restrict the output of variables(s) associated with this object
Default:none
C++ Type:std::vector
Options:
Description:Vector of output names were you would like to restrict the output of variables(s) associated with this object

Outputs Parameters

Input Files

modules/phase_field/test/tests/MultiPhase/crosstermbarrierfunction.i

modules/phase_field/test/tests/MultiPhase/crosstermbarrierfunction.i

[Mesh]
  type = GeneratedMesh
  dim = 1
  nx = 200
  xmin = 0
  xmax = 9
[]

[Functions]
  [./func1]
    type = ParsedFunction
    value = 'il:=x-7; ir:=2-x; if(x<1, 1,
                               if(x<2, 0.5-0.5*cos(ir*pi),
                               if(x<7, 0,
                               if(x<8, 0.5-0.5*cos(il*pi),
                               1))))'
  [../]
  [./func2]
    type = ParsedFunction
    value = 'il:=x-1; ir:=5-x; if(x<1, 0,
                               if(x<2, 0.5-0.5*cos(il*pi),
                               if(x<4, 1,
                               if(x<5, 0.5-0.5*cos(ir*pi),
                               0))))'
  [../]
  [./func3]
    type = ParsedFunction
    value = 'il:=x-4; ir:=8-x; if(x<4, 0,
                               if(x<5, 0.5-0.5*cos(il*pi),
                               if(x<7, 1,
                               if(x<8, 0.5-0.5*cos(ir*pi),
                               0))))'
  [../]
[]

[AuxVariables]
  [./eta1]
    order = FIRST
    family = LAGRANGE
    [./InitialCondition]
      type = FunctionIC
      function = func1
    [../]
  [../]
  [./eta2]
    order = FIRST
    family = LAGRANGE
    [./InitialCondition]
      type = FunctionIC
      function = func2
    [../]
  [../]
  [./eta3]
    order = FIRST
    family = LAGRANGE
    [./InitialCondition]
      type = FunctionIC
      function = func3
    [../]
  [../]
[]

[Materials]
  [./crosstermbarrier_simple]
    type = CrossTermBarrierFunctionMaterial
    etas = 'eta1 eta2 eta3'
    W_ij = '0   1   2.2
            1   0   3.1
            2.2 3.1 0'
    function_name = gsimple
    g_order = SIMPLE
    outputs = exodus
  [../]
  [./crosstermbarrier_low]
    type = CrossTermBarrierFunctionMaterial
    etas = 'eta1 eta2 eta3'
    W_ij = '0   1   2.2
            1   0   3.1
            2.2 3.1 0'
    function_name = glow
    g_order = LOW
    outputs = exodus
  [../]
[]

[Executioner]
  type = Transient
  solve_type = 'NEWTON'
  num_steps = 1
[]

[Problem]
  solve = false
  kernel_coverage_check = false
[]

[Outputs]
  exodus = true
  execute_on = final
[]

Input Parameters
Input Files

Application Usage

Physics and Syntax

Application Development

Framework Development

MOOSEDocs

Infrastructure

Questions

Information and Tools