RndBoundingBoxIC

under construction:Undocumented Class

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


# RndBoundingBoxIC

!syntax description /ICs/RndBoundingBoxIC

## Overview

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

## Example Input File Syntax

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

!syntax parameters /ICs/RndBoundingBoxIC

!syntax inputs /ICs/RndBoundingBoxIC

!syntax children /ICs/RndBoundingBoxIC

Random noise with different min/max inside/outside of a bounding box

Input Parameters

mx_invalueThe max value of the variable invalue the box
C++ Type:double
Options:
Description:The max value of the variable invalue the box
mx_outvalueThe max value of the variable outvalue the box
C++ Type:double
Options:
Description:The max value of the variable outvalue the box
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.
x1The x coordinate of the lower left-hand corner of the box
C++ Type:double
Options:
Description:The x coordinate of the lower left-hand corner of the box
x2The x coordinate of the upper right-hand corner of the box
C++ Type:double
Options:
Description:The x coordinate of the upper right-hand corner of the box
y1The y coordinate of the lower left-hand corner of the box
C++ Type:double
Options:
Description:The y coordinate of the lower left-hand corner of the box
y2The y coordinate of the upper right-hand corner of the box
C++ Type:double
Options:
Description:The y coordinate of the upper right-hand corner of the box

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
mn_invalue0The min value of the variable invalue the box
Default:0
C++ Type:double
Options:
Description:The min value of the variable invalue the box
mn_outvalue0The min value of the variable outvalue the box
Default:0
C++ Type:double
Options:
Description:The min value of the variable outvalue the box
z10The z coordinate of the lower left-hand corner of the box
Default:0
C++ Type:double
Options:
Description:The z coordinate of the lower left-hand corner of the box
z20The z coordinate of the upper right-hand corner of the box
Default:0
C++ Type:double
Options:
Description:The z coordinate of the upper right-hand corner of the box

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/RndBoundingBoxIC.i

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

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

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

[ICs]
  [./InitialCondition]
    type = RndBoundingBoxIC
    x1 = 15.0
    x2 = 35.0
    y1 = 0.0
    y2 = 25.0
    mx_invalue = 1.0
    mn_invalue = 0.9
    mx_outvalue = -0.7
    mn_outvalue = -0.8
    variable = c
  [../]
[]

[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 = 15
  nl_max_its = 10

  start_time = 0.0
  num_steps = 4
  dt = 5.0
[]

[Outputs]
  exodus = true
[]

Input Parameters
Input Files

Application Usage

Physics and Syntax

Application Development

Framework Development

MOOSEDocs

Infrastructure

Questions

Information and Tools