SmoothSuperellipsoidIC

construction:Undocumented Class

The SmoothSuperellipsoidIC 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.

Superellipsoid with a smooth interface

Overview

Example Input File Syntax

Input Parameters

aSemiaxis a of the superellipsoid
C++ Type:double
Controllable:No
Description:Semiaxis a of the superellipsoid
bSemiaxis b of the superellipsoid
C++ Type:double
Controllable:No
Description:Semiaxis b of the superellipsoid
invalueThe variable value inside the superellipsoid
C++ Type:double
Controllable:No
Description:The variable value inside the superellipsoid
nExponent n of the superellipsoid
C++ Type:double
Controllable:No
Description:Exponent n of the superellipsoid
outvalueThe variable value outside the superellipsoid
C++ Type:double
Controllable:No
Description:The variable value outside the superellipsoid
variableThe variable this initial condition is supposed to provide values for.
C++ Type:VariableName
Controllable:No
Description:The variable this initial condition is supposed to provide values for.
x1The x coordinate of the superellipsoid center
C++ Type:double
Controllable:No
Description:The x coordinate of the superellipsoid center
y1The y coordinate of the superellipsoid center
C++ Type:double
Controllable:No
Description:The y coordinate of the superellipsoid center

Required Parameters

blockThe list of blocks (ids or names) that this object will be applied
C++ Type:std::vector<SubdomainName>
Controllable:No
Description:The list of blocks (ids or names) that this object will be applied
boundaryThe list of boundaries (ids or names) from the mesh where this object applies
C++ Type:std::vector<BoundaryName>
Controllable:No
Description:The list of boundaries (ids or names) from the mesh where this object applies
c1Semiaxis c of the superellipsoid
Default:1
C++ Type:double
Controllable:No
Description:Semiaxis c of the superellipsoid
int_width0The interfacial width of the void surface. Defaults to sharp interface
Default:0
C++ Type:double
Controllable:No
Description:The interfacial width of the void surface. Defaults to sharp interface
nestedvalueThe variable value for nested particles inside the superellipsoid in inverse configuration
C++ Type:double
Controllable:No
Description:The variable value for nested particles inside the superellipsoid in inverse configuration
prop_getter_suffixAn optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.
C++ Type:MaterialPropertyName
Controllable:No
Description:An optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.
rand_seed12345Seed value for the random number generator
Default:12345
C++ Type:unsigned int
Controllable:No
Description:Seed value for the random number generator
use_interpolated_stateFalseFor the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.
Default:False
C++ Type:bool
Controllable:No
Description:For the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.
z10The z coordinate of the superellipsoid center
Default:0
C++ Type:double
Controllable:No
Description:The z coordinate of the superellipsoid center
zero_gradientFalseSet the gradient DOFs to zero. This can avoid numerical problems with higher order shape functions.
Default:False
C++ Type:bool
Controllable:No
Description:Set the gradient DOFs to zero. This can avoid numerical problems with higher order shape functions.

Optional Parameters

control_tagsAdds user-defined labels for accessing object parameters via control logic.
C++ Type:std::vector<std::string>
Controllable:No
Description:Adds user-defined labels for accessing object parameters via control logic.
enableTrueSet the enabled status of the MooseObject.
Default:True
C++ Type:bool
Controllable:No
Description:Set the enabled status of the MooseObject.
ignore_uo_dependencyFalseWhen set to true, a UserObject retrieved by this IC will not be executed before the this IC
Default:False
C++ Type:bool
Controllable:No
Description:When set to true, a UserObject retrieved by this IC will not be executed before the this IC

Advanced Parameters

Input Files

(modules/phase_field/test/tests/initial_conditions/SmoothSuperellipsoidIC.i)
(modules/phase_field/test/tests/initial_conditions/SmoothSuperellipsoidIC_3D.i)

(modules/phase_field/test/tests/initial_conditions/SmoothSuperellipsoidIC.i)

[Mesh]
  type = GeneratedMesh
  dim = 2
  nx = 25
  ny = 25
  xmax = 50
  ymax = 50
  elem_type = QUAD4
[]

[Variables]
  [./c]
    order = THIRD
    family = HERMITE
  [../]
[]

[ICs]
  [./c]
    type = SmoothSuperellipsoidIC
    variable = c
    x1 = 25.0
    y1 = 25.0
    a = 8.0
    b = 12.0
    n = 3.5
    invalue = 1.0
    outvalue = -0.8
    int_width = 4.0
  [../]
[]

[Kernels]
  [./ie_c]
    type = TimeDerivative
    variable = c
  [../]
  [./CHSolid]
    type = CHMath
    variable = c
    mob_name = M
  [../]
  [./CHInterface]
    type = CHInterface
    variable = c
    kappa_name = kappa_c
    mob_name = M
  [../]
[]

[BCs]
  [./Periodic]
    [./all]
      auto_direction = 'x y'
    [../]
  [../]
[]

[Materials]
  [./constant]
    type = GenericConstantMaterial
    prop_names  = 'M kappa_c'
    prop_values = '1.0 1.0'
  [../]
[]

[Executioner]
  type = Transient
  scheme = 'bdf2'
  solve_type = 'NEWTON'

  petsc_options_iname = '-pc_type -pc_hypre_type -ksp_gmres_restart'
  petsc_options_value = 'hypre boomeramg 31'

  l_max_its = 20
  l_tol = 1.0e-4
  nl_max_its = 40
  nl_rel_tol = 1e-9

  start_time = 0.0
  num_steps = 1
  dt = 2.0
[]

[Outputs]
  exodus = false
  [./out]
    type = Exodus
    refinements = 2
  [../]
[]

(modules/phase_field/test/tests/initial_conditions/SmoothSuperellipsoidIC_3D.i)

[Mesh]
  type = GeneratedMesh
  dim = 3
  nx = 15
  ny = 15
  nz = 15
  xmax = 50
  ymax = 50
  zmax = 50
  elem_type = HEX8
[]

[Variables]
  [./c]
  [../]
[]

[ICs]
  [./c]
    type = SmoothSuperellipsoidIC
    variable = c
    x1 = 25.0
    y1 = 25.0
    z1 = 25.0
    a = 8
    b = 12
    c = 16
    n = 3.5
    invalue = 1.0
    outvalue = 0
    int_width = 4.0
  [../]
[]

[Kernels]
  [./ie_c]
    type = TimeDerivative
    variable = c
  [../]
  [./Diffusion]
    type = MatDiffusion
    variable = c
  [../]
[]

[BCs]
  [./Periodic]
    [./All]
      auto_direction = 'x y z'
    [../]
  [../]
[]

[Materials]
  [./Diffusivity]
    type = GenericConstantMaterial
    prop_names = D
    prop_values = 1.0
  [../]
[]

[Executioner]
  type = Transient
  scheme = bdf2

  solve_type = 'NEWTON'
  petsc_options_iname = '-pc_type -pc_hypre_type -ksp_gmres_restart'
  petsc_options_value = 'hypre boomeramg 31'

  l_max_its = 20
  l_tol = 1.0e-5
  nl_max_its = 40
  nl_rel_tol = 5.0e-14

  start_time = 0.0
  num_steps = 1
  dt = 2.0
[]

[Outputs]
  exodus = true
[]

Overview
Example Input File Syntax
Input Parameters
Input Files