MultiSmoothSuperellipsoidIC

under construction:Undocumented Class

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


# MultiSmoothSuperellipsoidIC

!syntax description /ICs/MultiSmoothSuperellipsoidIC

## Overview

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

## Example Input File Syntax

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

!syntax parameters /ICs/MultiSmoothSuperellipsoidIC

!syntax inputs /ICs/MultiSmoothSuperellipsoidIC

!syntax children /ICs/MultiSmoothSuperellipsoidIC

Random distribution of smooth ellipse with given minimum spacing

Input Parameters

bubspacVector of the minimum spacing of bubbles of one type, measured from center to center
C++ Type:std::vector
Options:
Description:Vector of the minimum spacing of bubbles of one type, measured from center to center
invalueThe variable value inside the superellipsoid
C++ Type:double
Options:
Description:The variable value inside the superellipsoid
numbubVector of the number of bubbles to place
C++ Type:std::vector
Options:
Description:Vector of the number of bubbles to place
outvalueThe variable value outside the superellipsoid
C++ Type:double
Options:
Description:The variable value outside the superellipsoid
semiaxis_aVector of mean semiaxis values in the x direction for the ellipse
C++ Type:std::vector
Options:
Description:Vector of mean semiaxis values in the x direction for the ellipse
semiaxis_bVector of mean semiaxis values in the y direction for the ellipse
C++ Type:std::vector
Options:
Description:Vector of mean semiaxis values in the y direction for the ellipse
semiaxis_cVector of mean semiaxis values in the z direction for the ellipse, must be greater than 0 even if 2D.
C++ Type:std::vector
Options:
Description:Vector of mean semiaxis values in the z direction for the ellipse, must be greater than 0 even if 2D.
variableThe variable this initial condition is supposed to provide values for.
C++ Type:VariableName
Options:
Description:The variable this initial condition is supposed to provide values for.

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
check_extremesFalseCheck all Superellipsoid extremes (center +- each semiaxis) for overlap, must have prevent_overlap set to True.
Default:False
C++ Type:bool
Options:
Description:Check all Superellipsoid extremes (center +- each semiaxis) for overlap, must have prevent_overlap set to True.
exponentVector of exponents for each superellipsoid, n=2 is a normal ellipse
C++ Type:std::vector
Options:
Description:Vector of exponents for each superellipsoid, n=2 is a normal ellipse
int_width0The interfacial width of the void surface. Defaults to sharp interface
Default:0
C++ Type:double
Options:
Description:The interfacial width of the void surface. Defaults to sharp interface
max_num_tries1000The number of tries
Default:1000
C++ Type:unsigned int
Options:
Description:The number of tries
nestedvalueThe variable value for nested particles inside the superellipsoid in inverse configuration
C++ Type:double
Options:
Description:The variable value for nested particles inside the superellipsoid in inverse configuration
prevent_overlapFalseCheck all Superellipsoid centers for overlap with other superellipsoids.
Default:False
C++ Type:bool
Options:
Description:Check all Superellipsoid centers for overlap with other superellipsoids.
rand_seed12345Seed value for the random number generator
Default:12345
C++ Type:unsigned int
Options:
Description:Seed value for the random number generator
semiaxis_a_variationVector of plus or minus fractions of random variation in the bubble semiaxis in the x direction for uniform, standard deviation for normal
C++ Type:std::vector
Options:
Description:Vector of plus or minus fractions of random variation in the bubble semiaxis in the x direction for uniform, standard deviation for normal
semiaxis_b_variationVector of plus or minus fractions of random variation in the bubble semiaxis in the y direction for uniform, standard deviation for normal
C++ Type:std::vector
Options:
Description:Vector of plus or minus fractions of random variation in the bubble semiaxis in the y direction for uniform, standard deviation for normal
semiaxis_c_variationVector of plus or minus fractions of random variation in the bubble semiaxis in the z direction for uniform, standard deviation for normal. Must be set to 0 if 2D.
C++ Type:std::vector
Options:
Description:Vector of plus or minus fractions of random variation in the bubble semiaxis in the z direction for uniform, standard deviation for normal. Must be set to 0 if 2D.
semiaxis_variation_typenoneType of distribution that random superellipsoid semiaxes will follow
Default:none
C++ Type:MooseEnum
Options:uniform normal none
Description:Type of distribution that random superellipsoid semiaxes will follow
vary_axes_independentlyTrueIf true the length of each semiaxis is randomly chosen within the provided parameters, if false then one random number is generated and applied to all semiaxes.
Default:True
C++ Type:bool
Options:
Description:If true the length of each semiaxis is randomly chosen within the provided parameters, if false then one random number is generated and applied to all semiaxes.
zero_gradientFalseSet the gradient DOFs to zero. This can avoid numerical problems with higher order shape functions.
Default:False
C++ Type:bool
Options:
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
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.
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
Options:
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/MultiSmoothSuperellipsoidIC_2D.i
modules/phase_field/test/tests/initial_conditions/MultiSmoothSuperellipsoidIC_3D.i

modules/phase_field/test/tests/initial_conditions/MultiSmoothSuperellipsoidIC_2D.i

[Mesh]
  type = GeneratedMesh
  dim = 2
  nx = 50
  ny = 50
  nz = 0
  xmax = 100
  ymax = 100
  zmax = 0
  elem_type = QUAD4
[]

[Variables]
  [./c]
    order = FIRST
    family = LAGRANGE
  [../]
[]

[ICs]
  [./c]
    type = MultiSmoothSuperellipsoidIC
    variable = c
    invalue = 1.0
    outvalue = 0.1
    bubspac = '10 5'
    numbub = '5 5'
    semiaxis_b_variation = '0.25 0.35'
    semiaxis_variation_type = uniform
    semiaxis_a_variation = '0.2 0.3'
    semiaxis_a = '7 5'
    semiaxis_b = '10 8'
    exponent = '2 3'
    prevent_overlap = true
    semiaxis_c_variation = '0 0'
    semiaxis_c = '1 1'
  [../]
[]

[Executioner]
  type = Transient
  scheme = bdf2
  solve_type = PJFNK
  petsc_options_iname = '-pc_type -pc_hypre_type -ksp_gmres_restart -mat_mffd_type'
  petsc_options_value = 'hypre boomeramg 31 ds'
  l_max_its = 20
  l_tol = 1e-4
  nl_max_its = 20
  nl_rel_tol = 1e-9
  nl_abs_tol = 1e-11
  start_time = 0.0
  num_steps = 1
  dt = 100.0
  enable = false
  [./Adaptivity]
    refine_fraction = .5
  [../]
[]

[Outputs]
  exodus = true
[]

[Problem]
  type = FEProblem
  solve = false
[]

modules/phase_field/test/tests/initial_conditions/MultiSmoothSuperellipsoidIC_3D.i

[Mesh]
  type = GeneratedMesh
  dim = 3
  nx = 22
  ny = 22
  nz = 22
  xmin = 0
  xmax = 100
  ymin = 0
  ymax = 100
  zmin = 0
  zmax = 100
  elem_type = HEX8
[]

[Variables]
  [./c]
    order = FIRST
    family = LAGRANGE
  [../]
[]

[ICs]
  [./c]
    type = MultiSmoothSuperellipsoidIC
    variable = c
    invalue = 1.0
    outvalue = 0.1
    bubspac = '10 5'
    numbub = '5 5'
    semiaxis_b_variation = '0.25 0.35'
    semiaxis_variation_type = uniform
    semiaxis_a_variation = '0.2 0.3'
    semiaxis_a = '7 5'
    semiaxis_c_variation = '0.3 0.5'
    semiaxis_b = '10 8'
    semiaxis_c = '15 5'
    exponent = '2 3'
    prevent_overlap = true
    check_extremes = true
  [../]
[]

[Executioner]
  type = Transient
  scheme = bdf2
  solve_type = PJFNK
  petsc_options_iname = '-pc_type -pc_hypre_type -ksp_gmres_restart -mat_mffd_type'
  petsc_options_value = 'hypre boomeramg 31 ds'
  l_max_its = 20
  l_tol = 1e-4
  nl_max_its = 20
  nl_rel_tol = 1e-9
  nl_abs_tol = 1e-11
  start_time = 0.0
  num_steps = 1
  dt = 100.0
  enable = false
  [./Adaptivity]
    refine_fraction = .5
  [../]
[]

[Outputs]
  exodus = true
[]

[Problem]
  type = FEProblem
  solve = false
[]

Input Parameters
Input Files

Application Usage

Physics and Syntax

Application Development

Framework Development

MOOSEDocs

Infrastructure

Questions

Information and Tools