RegularSolutionFreeEnergy

under construction:Undocumented Class

The RegularSolutionFreeEnergy has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.


# RegularSolutionFreeEnergy

!syntax description /Materials/RegularSolutionFreeEnergy

## Overview

!! Replace these lines with information regarding the RegularSolutionFreeEnergy object.

## Example Input File Syntax

!! Describe and include an example of how to use the RegularSolutionFreeEnergy object.

!syntax parameters /Materials/RegularSolutionFreeEnergy

!syntax inputs /Materials/RegularSolutionFreeEnergy

!syntax children /Materials/RegularSolutionFreeEnergy

Material that implements the free energy of a regular solution

Input Parameters

cConcentration variable
C++ Type:std::vector
Options:
Description:Concentration variable

Required Parameters

T300.0Temperature variable
Default:300.0
C++ Type:std::vector
Options:
Description:Temperature variable
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
derivative_order3Maximum order of derivatives taken
Default:3
C++ Type:unsigned int
Options:
Description:Maximum order of derivatives taken
f_nameFBase name of the free energy function (used to name the material properties)
Default:F
C++ Type:std::string
Options:
Description:Base name of the free energy function (used to name the material properties)
kB8.61733e-05Boltzmann constant
Default:8.61733e-05
C++ Type:double
Options:
Description:Boltzmann constant
log_tolIf specified logarithms are evaluated using a Taylor expansion below this value
C++ Type:double
Options:
Description:If specified logarithms are evaluated using a Taylor expansion below this value
omega0.1Regular solution parameter
Default:0.1
C++ Type:double
Options:
Description:Regular solution parameter

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.
disable_fpoptimizerFalseDisable the function parser algebraic optimizer
Default:False
C++ Type:bool
Options:
Description:Disable the function parser algebraic optimizer
enableTrueSet the enabled status of the MooseObject.
Default:True
C++ Type:bool
Options:
Description:Set the enabled status of the MooseObject.
enable_ad_cacheTrueEnable cacheing of function derivatives for faster startup time
Default:True
C++ Type:bool
Options:
Description:Enable cacheing of function derivatives for faster startup time
enable_auto_optimizeTrueEnable automatic immediate optimization of derivatives
Default:True
C++ Type:bool
Options:
Description:Enable automatic immediate optimization of derivatives
enable_jitTrueEnable just-in-time compilation of function expressions for faster evaluation
Default:True
C++ Type:bool
Options:
Description:Enable just-in-time compilation of function expressions for faster evaluation
fail_on_evalerrorFalseFail fatally if a function evaluation returns an error code (otherwise just pass on NaN)
Default:False
C++ Type:bool
Options:
Description:Fail fatally if a function evaluation returns an error code (otherwise just pass on NaN)
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/free_energy_material/RegularSolutionFreeEnergy_plog.i
modules/phase_field/test/tests/free_energy_material/RegularSolutionFreeEnergy_const_T.i
modules/phase_field/test/tests/free_energy_material/RegularSolutionFreeEnergy.i

modules/phase_field/test/tests/free_energy_material/RegularSolutionFreeEnergy_plog.i

[Mesh]
  type = GeneratedMesh
  dim = 1
  nx = 50
  xmax = 1
[]

[Variables]
  [./c]
    order = FIRST
    family = LAGRANGE
    [./InitialCondition]
      type = FunctionIC
      function = x
    [../]
  [../]
[]

[Kernels]
  [./diff]
    type = Diffusion
    variable = c
  [../]
[]

[BCs]
  [./left]
    type = FunctionDirichletBC
    variable = c
    boundary = left
    function = x
  [../]
  [./right]
    type = FunctionDirichletBC
    variable = c
    boundary = right
    function = x
  [../]
[]

[Materials]
  [./free_energy]
    type = RegularSolutionFreeEnergy
    f_name = F
    c = c
    outputs = out
    log_tol = 0.2
  [../]
[]

[Executioner]
  type = Steady
  solve_type = NEWTON
  l_max_its = 1
  nl_max_its = 1
  nl_abs_tol = 1
[]

[Outputs]
  execute_on = 'timestep_end'
  [./out]
    type = Exodus
    execute_on = timestep_end
  [../]
[]

modules/phase_field/test/tests/free_energy_material/RegularSolutionFreeEnergy_const_T.i

[Mesh]
  type = GeneratedMesh
  dim = 1
  nx = 10
  xmax = 1
[]

[Variables]
  [./c]
    order = FIRST
    family = LAGRANGE
    [./InitialCondition]
      type = FunctionIC
      function = x
    [../]
  [../]
[]

[Kernels]
  [./diff]
    type = Diffusion
    variable = c
  [../]
[]

[BCs]
  [./left]
    type = FunctionDirichletBC
    variable = c
    boundary = left
    function = x
  [../]
  [./right]
    type = FunctionDirichletBC
    variable = c
    boundary = right
    function = x
  [../]
[]

[Materials]
  [./free_energy]
    type = RegularSolutionFreeEnergy
    f_name = F
    c = c
    outputs = out
  [../]
[]

[Executioner]
  type = Steady
  solve_type = NEWTON
  l_max_its = 1
  nl_max_its = 1
  nl_abs_tol = 1
[]

[Outputs]
  execute_on = 'timestep_end'
  [./out]
    type = Exodus
    execute_on = timestep_end
  [../]
[]

modules/phase_field/test/tests/free_energy_material/RegularSolutionFreeEnergy.i

[Mesh]
  type = GeneratedMesh
  dim = 2
  nx = 10
  ny = 10
  xmax = 1
  ymax = 500
  elem_type = QUAD4
[]

[Variables]
  [./c]
    order = FIRST
    family = LAGRANGE
    [./InitialCondition]
      type = FunctionIC
      function = x
    [../]
  [../]
  [./myT]
    order = FIRST
    family = LAGRANGE
    [./InitialCondition]
      type = FunctionIC
      function = y
    [../]
  [../]
[]

[Kernels]
  [./diff]
    type = Diffusion
    variable = c
  [../]
  [./diff2]
    type = Diffusion
    variable = myT
  [../]
[]

[BCs]
  [./left]
    type = FunctionDirichletBC
    variable = c
    boundary = left
    function = x
  [../]
  [./bottom]
    type = FunctionDirichletBC
    variable = myT
    boundary = bottom
    function = y
  [../]
  [./right]
    type = FunctionDirichletBC
    variable = c
    boundary = right
    function = x
  [../]
  [./top]
    type = FunctionDirichletBC
    variable = myT
    boundary = top
    function = y
  [../]
[]

[Materials]
  [./free_energy]
    type = RegularSolutionFreeEnergy
    f_name = F
    c = c
    T = myT
    outputs = out
  [../]
[]

[Executioner]
  type = Steady
  solve_type = NEWTON
  l_max_its = 1
  nl_max_its = 1
  nl_abs_tol = 1
[]

[Outputs]
  execute_on = 'timestep_end'
  [./out]
    type = Exodus
    execute_on = timestep_end
  [../]
[]

Input Parameters
Input Files

Application Usage

Physics and Syntax

Application Development

Framework Development

MOOSEDocs

Infrastructure

Questions

Information and Tools