SmoothCircleFromFileIC

under construction:Undocumented Class

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


# SmoothCircleFromFileIC

!syntax description /ICs/SmoothCircleFromFileIC

## Overview

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

## Example Input File Syntax

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

!syntax parameters /ICs/SmoothCircleFromFileIC

!syntax inputs /ICs/SmoothCircleFromFileIC

!syntax children /ICs/SmoothCircleFromFileIC

Multiple smooth circles read from a text file

Input Parameters

file_nameFile containing circle centers and radii
C++ Type:FileName
Options:
Description:File containing circle centers and radii
invalueThe variable value inside the circle
C++ Type:double
Options:
Description:The variable value inside the circle
outvalueThe variable value outside the circle
C++ Type:double
Options:
Description:The variable value outside the circle
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

3D_spheresTruein 3D, whether the objects are spheres or columns
Default:True
C++ Type:bool
Options:
Description:in 3D, whether the objects are spheres or columns
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
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
profileCOSFunctional dependence for the interface profile
Default:COS
C++ Type:MooseEnum
Options:COS TANH
Description:Functional dependence for the interface profile
rand_seed12345Seed value for the random number generator
Default:12345
C++ Type:unsigned int
Options:
Description:Seed value for the random number generator
zero_gradientFalseSet the gradient DOFs to zero. This can avoid numerical problems with higher order shape functions and overlapping circles.
Default:False
C++ Type:bool
Options:
Description:Set the gradient DOFs to zero. This can avoid numerical problems with higher order shape functions and overlapping circles.

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

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

[Mesh]
  type = GeneratedMesh
  dim = 2
  nx = 100
  ny = 56
  nz = 0
  xmin = 0
  xmax = 200
  ymin = 0
  ymax = 112
  zmin = 0
  zmax = 0
[]

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

[ICs]
  [./IC_c]
    type = SmoothCircleFromFileIC
    file_name = 'circles.txt'
    invalue = 1
    outvalue = 0
    variable = c
    int_width = 6
  [../]
[]

[Kernels]
  [./c_dot]
    type = TimeDerivative
    variable = c
  [../]
[]

[Executioner]
  type = Transient
  scheme = bdf2
  solve_type = PJFNK
  num_steps = 0
[]

[Outputs]
  exodus = true
  csv = false
[]

Input Parameters
Input Files

Application Usage

Physics and Syntax

Application Development

Framework Development

MOOSEDocs

Infrastructure

Questions

Information and Tools