mechanics

Input name Description Value
alamo.program which integrator to use (can only be mechanics) mechanics
alamo.program.mechanics.model which mechanics model to use linear.isotropic


Integrator::Mechanics<Model::Solid::Linear::Isotropic>

Input name Description Value
type Type of mecahnics to use. Static: do full implicit solve. Dynamic: evolve dynamic equations with explicit dynamics Disable: do nothing. disable static dynamic
time_evolving Treat mechanics fields as changing in time. [false] You should use this if you care about other physics driven by the output of this integrator. false
plot_disp Include displacement field in output true
plot_rhs Include right-hand side in output true
plot_psi Include \(\psi\) field in output true
plot_stress Include stress in output true
plot_strain Include strain in output true
viscous.mu_dashpot Dashpot damping (damps velocity) 0.0
viscous.mu_newton Newtonian viscous damping (damps velocity gradient) 0.0
velocity.ic.type Initializer for RHS none expression
bc.type Select the mechanical boundary conditions

bc.constant.type.xloylozlo 3D Corner
bc.constant.type.xloylozhi 3D Corner
bc.constant.type.xloyhizlo 3D Corner
bc.constant.type.xloyhizhi 3D Corner
bc.constant.type.xhiylozlo 3D Corner
bc.constant.type.xhiylozhi 3D Corner
bc.constant.type.xhiyhizlo 3D Corner
bc.constant.type.xhiyhizhi 3D Corner
bc.constant.type.ylozlo 3D Edge
bc.constant.type.ylozhi 3D Edge
bc.constant.type.yhizlo 3D Edge
bc.constant.type.yhizhi 3D Edge
bc.constant.type.zloxlo 3D Edge
bc.constant.type.zloxhi 3D Edge
bc.constant.type.zhixlo 3D Edge
bc.constant.type.zhixhi 3D Edge
bc.constant.type.xloylo 3D Edge / 2D Corner
bc.constant.type.xloyhi 3D Edge / 2D Corner
bc.constant.type.xhiylo 3D Edge / 2D Corner
bc.constant.type.xhiyhi 3D Edge / 2D Corner
bc.constant.type.xlo 3D Face / 2D Edge
bc.constant.type.xhi 3D Face / 2D Edge
bc.constant.type.ylo 3D Face / 2D Edge
bc.constant.type.yhi 3D Face / 2D Edge
bc.constant.type.zlo 3D Face
bc.constant.type.zhi 3D Face
bc.constant.val.xloylozlo 3D Corner
bc.constant.val.xloylozhi 3D Corner
bc.constant.val.xloyhizlo 3D Corner
bc.constant.val.xloyhizhi 3D Corner
bc.constant.val.xhiylozlo 3D Corner
bc.constant.val.xhiylozhi 3D Corner
bc.constant.val.xhiyhizlo 3D Corner
bc.constant.val.xhiyhizhi 3D Corner
bc.constant.val.ylozlo 3D Edge
bc.constant.val.ylozhi 3D Edge
bc.constant.val.yhizlo 3D Edge
bc.constant.val.yhizhi 3D Edge
bc.constant.val.zloxlo 3D Edge
bc.constant.val.zloxhi 3D Edge
bc.constant.val.zhixlo 3D Edge
bc.constant.val.zhixhi 3D Edge
bc.constant.val.xloylo 3D Edge / 2D Corner
bc.constant.val.xloyhi 3D Edge / 2D Corner
bc.constant.val.xhiylo 3D Edge / 2D Corner
bc.constant.val.xhiyhi 3D Edge / 2D Corner
bc.constant.val.xlo 3D Face / 2D Edge
bc.constant.val.xhi 3D Face / 2D Edge
bc.constant.val.ylo 3D Face / 2D Edge
bc.constant.val.yhi 3D Face / 2D Edge
bc.constant.val.zlo 3D Face
bc.constant.val.zhi 3D Face
bc.tensiontest.type Tension test type. uniaxial_stress_clamp uniaxial_kolsky uniaxial_stress uniaxial_strain
bc.tensiontest.disp Applied displacement (can be interpolator)
bc.tensiontest.trac Applied traction (can be interpolator)
print_model Print out model variables (if enabled by model) false
rhs.type initial condition for right hand side (body force)

rhs.constant.value Array of constant values. The number of values should equal either 1 or N where N is the number of fab components required
rhs.expression.coord coordinate system to use cartesian polar
rhs.expression.region# Mathematical expression in terms of x,y,z,t (if coord=cartesian) or r,theta,z,t (if coord=polar) and any defined constants. # = 0,1,2,...
rhs.trig.nr Number of real (cosin) waves
rhs.trig.ni Number of imaginary (sin) waves
rhs.trig.dim Spatial dimension
rhs.trig.alpha Multiplier
interval Timestep interval for elastic solves (default - solve every time) 0
max_coarsening_level Maximum multigrid coarsening level (default - none, maximum coarsening) -1
print_residual Whether to include residual output field false
elastic_ref_threshold Whether to refine based on elastic solution 0.01
zero_out_displacement Set this to true to zero out the displacement before each solve. (This is a temporary fix - we need to figure out why this is needed.) false
tstart Time to start doing the elastic solve (by default, start immediately) -1.0
nmodels Number of elastic model varieties 1
model#.lambda model#.mu model#.E model#.nu model#.kappa Specify exactly 2: required
Specify exactly two of: lame constant \(\lambda\), shear modulus \(\mu\), Young's modulus \(E\), Poisson's ratio \(\nu\), bulk modulus \(\kappa\). \(\mu\) and \(\lambda\) are how the final values are stored.
model#.planestress Whether or not to use the `plane stress `_ approximation. false
eta_ref_threshold Refinement threshold for eta field 0.01
ref_threshold Refinement threshold for strain gradient 0.01
model_neumann_boundary Explicity impose neumann condition on model at domain boundaries (2d only) false
ic.type Select the initial condition for eta

ic.constant.value Array of constant values. The number of values should equal either 1 or N where N is the number of fab components required
ic.ellipse.x0 Coorinates of ellipse center
ic.ellipse.eps Diffuse boundary thickness 0.0
ic.ellipse.A DxD square matrix defining an ellipse.
ic.ellipse.a If A is not defined, then assume a sphere with radius a
ic.ellipse.number_of_inclusions Number of ellipses
ic.ellipse.center center of the ellipse
ic.ellipse.x0 center of the ellipse
ic.ellipse.A either a vector containing ellipse radii, or a matrix defining the ellipse
ic.ellipse.A Same
ic.ellipse.radius Array of radii [depricated]
ic.ellipse.eps Regularization for smooth boundary
ic.ellipse.invert Flip the inside and the outside
ic.voronoi.number_of_grains Number of grains
ic.voronoi.alpha Value to take in the region [1.0]
ic.voronoi.seed Random seed to use
ic.bmp.filename BMP filename. file path
ic.bmp.fit How to position image in space stretch fitheight fitwidth coord
ic.bmp.coord.lo Location of lower-left corner in the domain
ic.bmp.coord.hi Location of upper-right corner in the domain
ic.bmp.channel Color channel to use r g b R G B
ic.bmp.min Scaling value - minimum 0.0
ic.bmp.max Scaling value - maximum 255.0
ic.png.channel Color channel to use (options: r, R, g, G, b, B, a, A) r g b a R G B A
ic.png.filename BMP filename. file path
ic.png.fit how to position the image stretch fitheight fitwidth coord
ic.png.coord.lo Lower-left coordinates of image in domain
ic.png.coord.hi Upper-right coordinates of image in domain
ic.png.min Desired minimum value to scale pixels by 0.0
ic.png.max Desired maximum value to scale pixels by 255.0
ic.expression.coord coordinate system to use cartesian polar
ic.expression.region# Mathematical expression in terms of x,y,z,t (if coord=cartesian) or r,theta,z,t (if coord=polar) and any defined constants. # = 0,1,2,...
ic.psread.eps Diffuseness of the sphere boundary
ic.psread.filename Location of .xyzr file file path
ic.psread.verbose Verbosity (used in parser only)
ic.psread.mult Coordinate multiplier
ic.psread.invert Coordinate multiplier
ic.psread.x0 Coordinate offset
eta.reset_on_regrid Whether to re-initialize eta when re-gridding occurs. Default is false unless eta ic is set, then default is. true. true
psi.ic.type Select initial condition for psi field

psi.ic.ellipse.x0 Coorinates of ellipse center
psi.ic.ellipse.eps Diffuse boundary thickness 0.0
psi.ic.ellipse.A DxD square matrix defining an ellipse.
psi.ic.ellipse.a If A is not defined, then assume a sphere with radius a
psi.ic.ellipse.number_of_inclusions Number of ellipses
psi.ic.ellipse.center center of the ellipse
psi.ic.ellipse.x0 center of the ellipse
psi.ic.ellipse.A either a vector containing ellipse radii, or a matrix defining the ellipse
psi.ic.ellipse.A Same
psi.ic.ellipse.radius Array of radii [depricated]
psi.ic.ellipse.eps Regularization for smooth boundary
psi.ic.ellipse.invert Flip the inside and the outside
psi.ic.constant.value Array of constant values. The number of values should equal either 1 or N where N is the number of fab components required
psi.ic.expression.coord coordinate system to use cartesian polar
psi.ic.expression.region# Mathematical expression in terms of x,y,z,t (if coord=cartesian) or r,theta,z,t (if coord=polar) and any defined constants. # = 0,1,2,...
psi.ic.psread.eps Diffuseness of the sphere boundary
psi.ic.psread.filename Location of .xyzr file file path
psi.ic.psread.verbose Verbosity (used in parser only)
psi.ic.psread.mult Coordinate multiplier
psi.ic.psread.invert Coordinate multiplier
psi.ic.psread.x0 Coordinate offset
psi.ic.png.channel Color channel to use (options: r, R, g, G, b, B, a, A) r g b a R G B A
psi.ic.png.filename BMP filename. file path
psi.ic.png.fit how to position the image stretch fitheight fitwidth coord
psi.ic.png.coord.lo Lower-left coordinates of image in domain
psi.ic.png.coord.hi Upper-right coordinates of image in domain
psi.ic.png.min Desired minimum value to scale pixels by 0.0
psi.ic.png.max Desired maximum value to scale pixels by 255.0
psi.reset_on_regrid Whether to re-initialize psi when re-gridding occurs. Default is false unless a psi ic is set, then default is true. true
trac_normal.ic.type Read in IC for the "normal traction" field (applied at diffuse boundaries)

trac_normal.ic.ellipse.x0 Coorinates of ellipse center
trac_normal.ic.ellipse.eps Diffuse boundary thickness 0.0
trac_normal.ic.ellipse.A DxD square matrix defining an ellipse.
trac_normal.ic.ellipse.a If A is not defined, then assume a sphere with radius a
trac_normal.ic.ellipse.number_of_inclusions Number of ellipses
trac_normal.ic.ellipse.center center of the ellipse
trac_normal.ic.ellipse.x0 center of the ellipse
trac_normal.ic.ellipse.A either a vector containing ellipse radii, or a matrix defining the ellipse
trac_normal.ic.ellipse.A Same
trac_normal.ic.ellipse.radius Array of radii [depricated]
trac_normal.ic.ellipse.eps Regularization for smooth boundary
trac_normal.ic.ellipse.invert Flip the inside and the outside
trac_normal.ic.constant.value Array of constant values. The number of values should equal either 1 or N where N is the number of fab components required
trac_normal.ic.expression.coord coordinate system to use cartesian polar
trac_normal.ic.expression.region# Mathematical expression in terms of x,y,z,t (if coord=cartesian) or r,theta,z,t (if coord=polar) and any defined constants. # = 0,1,2,...
trac_normal.ic.psread.eps Diffuseness of the sphere boundary
trac_normal.ic.psread.filename Location of .xyzr file file path
trac_normal.ic.psread.verbose Verbosity (used in parser only)
trac_normal.ic.psread.mult Coordinate multiplier
trac_normal.ic.psread.invert Coordinate multiplier
trac_normal.ic.psread.x0 Coordinate offset


Integrator::Mechanics<Model::Solid::Linear::Cubic>

Input name Description Value
type Type of mecahnics to use. Static: do full implicit solve. Dynamic: evolve dynamic equations with explicit dynamics Disable: do nothing. disable static dynamic
time_evolving Treat mechanics fields as changing in time. [false] You should use this if you care about other physics driven by the output of this integrator. false
plot_disp Include displacement field in output true
plot_rhs Include right-hand side in output true
plot_psi Include \(\psi\) field in output true
plot_stress Include stress in output true
plot_strain Include strain in output true
viscous.mu_dashpot Dashpot damping (damps velocity) 0.0
viscous.mu_newton Newtonian viscous damping (damps velocity gradient) 0.0
velocity.ic.type Initializer for RHS none expression
bc.type Select the mechanical boundary conditions

bc.constant.type.xloylozlo 3D Corner
bc.constant.type.xloylozhi 3D Corner
bc.constant.type.xloyhizlo 3D Corner
bc.constant.type.xloyhizhi 3D Corner
bc.constant.type.xhiylozlo 3D Corner
bc.constant.type.xhiylozhi 3D Corner
bc.constant.type.xhiyhizlo 3D Corner
bc.constant.type.xhiyhizhi 3D Corner
bc.constant.type.ylozlo 3D Edge
bc.constant.type.ylozhi 3D Edge
bc.constant.type.yhizlo 3D Edge
bc.constant.type.yhizhi 3D Edge
bc.constant.type.zloxlo 3D Edge
bc.constant.type.zloxhi 3D Edge
bc.constant.type.zhixlo 3D Edge
bc.constant.type.zhixhi 3D Edge
bc.constant.type.xloylo 3D Edge / 2D Corner
bc.constant.type.xloyhi 3D Edge / 2D Corner
bc.constant.type.xhiylo 3D Edge / 2D Corner
bc.constant.type.xhiyhi 3D Edge / 2D Corner
bc.constant.type.xlo 3D Face / 2D Edge
bc.constant.type.xhi 3D Face / 2D Edge
bc.constant.type.ylo 3D Face / 2D Edge
bc.constant.type.yhi 3D Face / 2D Edge
bc.constant.type.zlo 3D Face
bc.constant.type.zhi 3D Face
bc.constant.val.xloylozlo 3D Corner
bc.constant.val.xloylozhi 3D Corner
bc.constant.val.xloyhizlo 3D Corner
bc.constant.val.xloyhizhi 3D Corner
bc.constant.val.xhiylozlo 3D Corner
bc.constant.val.xhiylozhi 3D Corner
bc.constant.val.xhiyhizlo 3D Corner
bc.constant.val.xhiyhizhi 3D Corner
bc.constant.val.ylozlo 3D Edge
bc.constant.val.ylozhi 3D Edge
bc.constant.val.yhizlo 3D Edge
bc.constant.val.yhizhi 3D Edge
bc.constant.val.zloxlo 3D Edge
bc.constant.val.zloxhi 3D Edge
bc.constant.val.zhixlo 3D Edge
bc.constant.val.zhixhi 3D Edge
bc.constant.val.xloylo 3D Edge / 2D Corner
bc.constant.val.xloyhi 3D Edge / 2D Corner
bc.constant.val.xhiylo 3D Edge / 2D Corner
bc.constant.val.xhiyhi 3D Edge / 2D Corner
bc.constant.val.xlo 3D Face / 2D Edge
bc.constant.val.xhi 3D Face / 2D Edge
bc.constant.val.ylo 3D Face / 2D Edge
bc.constant.val.yhi 3D Face / 2D Edge
bc.constant.val.zlo 3D Face
bc.constant.val.zhi 3D Face
bc.tensiontest.type Tension test type. uniaxial_stress_clamp uniaxial_kolsky uniaxial_stress uniaxial_strain
bc.tensiontest.disp Applied displacement (can be interpolator)
bc.tensiontest.trac Applied traction (can be interpolator)
print_model Print out model variables (if enabled by model) false
rhs.type initial condition for right hand side (body force)

rhs.constant.value Array of constant values. The number of values should equal either 1 or N where N is the number of fab components required
rhs.expression.coord coordinate system to use cartesian polar
rhs.expression.region# Mathematical expression in terms of x,y,z,t (if coord=cartesian) or r,theta,z,t (if coord=polar) and any defined constants. # = 0,1,2,...
rhs.trig.nr Number of real (cosin) waves
rhs.trig.ni Number of imaginary (sin) waves
rhs.trig.dim Spatial dimension
rhs.trig.alpha Multiplier
interval Timestep interval for elastic solves (default - solve every time) 0
max_coarsening_level Maximum multigrid coarsening level (default - none, maximum coarsening) -1
print_residual Whether to include residual output field false
elastic_ref_threshold Whether to refine based on elastic solution 0.01
zero_out_displacement Set this to true to zero out the displacement before each solve. (This is a temporary fix - we need to figure out why this is needed.) false
tstart Time to start doing the elastic solve (by default, start immediately) -1.0
nmodels Number of elastic model varieties 1
model#.C11 Elastic constant 1.68
model#.C12 Elastic constant 1.21
model#.C44 Elastic constant 0.75
model#.anglefmt specify whether using radians or degrees radians degrees
model#.phi1 Bunge Euler angle \(\phi_1\) about x axis 0.0
model#.Phi Bunge Euler angle \(\Phi\) about z axis 0.0
model#.phi2 Bunge Euler angle \(\phi_2\) about x axis 0.0
eta_ref_threshold Refinement threshold for eta field 0.01
ref_threshold Refinement threshold for strain gradient 0.01
model_neumann_boundary Explicity impose neumann condition on model at domain boundaries (2d only) false
ic.type Select the initial condition for eta

ic.constant.value Array of constant values. The number of values should equal either 1 or N where N is the number of fab components required
ic.ellipse.x0 Coorinates of ellipse center
ic.ellipse.eps Diffuse boundary thickness 0.0
ic.ellipse.A DxD square matrix defining an ellipse.
ic.ellipse.a If A is not defined, then assume a sphere with radius a
ic.ellipse.number_of_inclusions Number of ellipses
ic.ellipse.center center of the ellipse
ic.ellipse.x0 center of the ellipse
ic.ellipse.A either a vector containing ellipse radii, or a matrix defining the ellipse
ic.ellipse.A Same
ic.ellipse.radius Array of radii [depricated]
ic.ellipse.eps Regularization for smooth boundary
ic.ellipse.invert Flip the inside and the outside
ic.voronoi.number_of_grains Number of grains
ic.voronoi.alpha Value to take in the region [1.0]
ic.voronoi.seed Random seed to use
ic.bmp.filename BMP filename. file path
ic.bmp.fit How to position image in space stretch fitheight fitwidth coord
ic.bmp.coord.lo Location of lower-left corner in the domain
ic.bmp.coord.hi Location of upper-right corner in the domain
ic.bmp.channel Color channel to use r g b R G B
ic.bmp.min Scaling value - minimum 0.0
ic.bmp.max Scaling value - maximum 255.0
ic.png.channel Color channel to use (options: r, R, g, G, b, B, a, A) r g b a R G B A
ic.png.filename BMP filename. file path
ic.png.fit how to position the image stretch fitheight fitwidth coord
ic.png.coord.lo Lower-left coordinates of image in domain
ic.png.coord.hi Upper-right coordinates of image in domain
ic.png.min Desired minimum value to scale pixels by 0.0
ic.png.max Desired maximum value to scale pixels by 255.0
ic.expression.coord coordinate system to use cartesian polar
ic.expression.region# Mathematical expression in terms of x,y,z,t (if coord=cartesian) or r,theta,z,t (if coord=polar) and any defined constants. # = 0,1,2,...
ic.psread.eps Diffuseness of the sphere boundary
ic.psread.filename Location of .xyzr file file path
ic.psread.verbose Verbosity (used in parser only)
ic.psread.mult Coordinate multiplier
ic.psread.invert Coordinate multiplier
ic.psread.x0 Coordinate offset
eta.reset_on_regrid Whether to re-initialize eta when re-gridding occurs. Default is false unless eta ic is set, then default is. true. true
psi.ic.type Select initial condition for psi field

psi.ic.ellipse.x0 Coorinates of ellipse center
psi.ic.ellipse.eps Diffuse boundary thickness 0.0
psi.ic.ellipse.A DxD square matrix defining an ellipse.
psi.ic.ellipse.a If A is not defined, then assume a sphere with radius a
psi.ic.ellipse.number_of_inclusions Number of ellipses
psi.ic.ellipse.center center of the ellipse
psi.ic.ellipse.x0 center of the ellipse
psi.ic.ellipse.A either a vector containing ellipse radii, or a matrix defining the ellipse
psi.ic.ellipse.A Same
psi.ic.ellipse.radius Array of radii [depricated]
psi.ic.ellipse.eps Regularization for smooth boundary
psi.ic.ellipse.invert Flip the inside and the outside
psi.ic.constant.value Array of constant values. The number of values should equal either 1 or N where N is the number of fab components required
psi.ic.expression.coord coordinate system to use cartesian polar
psi.ic.expression.region# Mathematical expression in terms of x,y,z,t (if coord=cartesian) or r,theta,z,t (if coord=polar) and any defined constants. # = 0,1,2,...
psi.ic.psread.eps Diffuseness of the sphere boundary
psi.ic.psread.filename Location of .xyzr file file path
psi.ic.psread.verbose Verbosity (used in parser only)
psi.ic.psread.mult Coordinate multiplier
psi.ic.psread.invert Coordinate multiplier
psi.ic.psread.x0 Coordinate offset
psi.ic.png.channel Color channel to use (options: r, R, g, G, b, B, a, A) r g b a R G B A
psi.ic.png.filename BMP filename. file path
psi.ic.png.fit how to position the image stretch fitheight fitwidth coord
psi.ic.png.coord.lo Lower-left coordinates of image in domain
psi.ic.png.coord.hi Upper-right coordinates of image in domain
psi.ic.png.min Desired minimum value to scale pixels by 0.0
psi.ic.png.max Desired maximum value to scale pixels by 255.0
psi.reset_on_regrid Whether to re-initialize psi when re-gridding occurs. Default is false unless a psi ic is set, then default is true. true
trac_normal.ic.type Read in IC for the "normal traction" field (applied at diffuse boundaries)

trac_normal.ic.ellipse.x0 Coorinates of ellipse center
trac_normal.ic.ellipse.eps Diffuse boundary thickness 0.0
trac_normal.ic.ellipse.A DxD square matrix defining an ellipse.
trac_normal.ic.ellipse.a If A is not defined, then assume a sphere with radius a
trac_normal.ic.ellipse.number_of_inclusions Number of ellipses
trac_normal.ic.ellipse.center center of the ellipse
trac_normal.ic.ellipse.x0 center of the ellipse
trac_normal.ic.ellipse.A either a vector containing ellipse radii, or a matrix defining the ellipse
trac_normal.ic.ellipse.A Same
trac_normal.ic.ellipse.radius Array of radii [depricated]
trac_normal.ic.ellipse.eps Regularization for smooth boundary
trac_normal.ic.ellipse.invert Flip the inside and the outside
trac_normal.ic.constant.value Array of constant values. The number of values should equal either 1 or N where N is the number of fab components required
trac_normal.ic.expression.coord coordinate system to use cartesian polar
trac_normal.ic.expression.region# Mathematical expression in terms of x,y,z,t (if coord=cartesian) or r,theta,z,t (if coord=polar) and any defined constants. # = 0,1,2,...
trac_normal.ic.psread.eps Diffuseness of the sphere boundary
trac_normal.ic.psread.filename Location of .xyzr file file path
trac_normal.ic.psread.verbose Verbosity (used in parser only)
trac_normal.ic.psread.mult Coordinate multiplier
trac_normal.ic.psread.invert Coordinate multiplier
trac_normal.ic.psread.x0 Coordinate offset


Integrator::Mechanics<Model::Solid::Affine::Cubic>

Input name Description Value
type Type of mecahnics to use. Static: do full implicit solve. Dynamic: evolve dynamic equations with explicit dynamics Disable: do nothing. disable static dynamic
time_evolving Treat mechanics fields as changing in time. [false] You should use this if you care about other physics driven by the output of this integrator. false
plot_disp Include displacement field in output true
plot_rhs Include right-hand side in output true
plot_psi Include \(\psi\) field in output true
plot_stress Include stress in output true
plot_strain Include strain in output true
viscous.mu_dashpot Dashpot damping (damps velocity) 0.0
viscous.mu_newton Newtonian viscous damping (damps velocity gradient) 0.0
velocity.ic.type Initializer for RHS none expression
bc.type Select the mechanical boundary conditions

bc.constant.type.xloylozlo 3D Corner
bc.constant.type.xloylozhi 3D Corner
bc.constant.type.xloyhizlo 3D Corner
bc.constant.type.xloyhizhi 3D Corner
bc.constant.type.xhiylozlo 3D Corner
bc.constant.type.xhiylozhi 3D Corner
bc.constant.type.xhiyhizlo 3D Corner
bc.constant.type.xhiyhizhi 3D Corner
bc.constant.type.ylozlo 3D Edge
bc.constant.type.ylozhi 3D Edge
bc.constant.type.yhizlo 3D Edge
bc.constant.type.yhizhi 3D Edge
bc.constant.type.zloxlo 3D Edge
bc.constant.type.zloxhi 3D Edge
bc.constant.type.zhixlo 3D Edge
bc.constant.type.zhixhi 3D Edge
bc.constant.type.xloylo 3D Edge / 2D Corner
bc.constant.type.xloyhi 3D Edge / 2D Corner
bc.constant.type.xhiylo 3D Edge / 2D Corner
bc.constant.type.xhiyhi 3D Edge / 2D Corner
bc.constant.type.xlo 3D Face / 2D Edge
bc.constant.type.xhi 3D Face / 2D Edge
bc.constant.type.ylo 3D Face / 2D Edge
bc.constant.type.yhi 3D Face / 2D Edge
bc.constant.type.zlo 3D Face
bc.constant.type.zhi 3D Face
bc.constant.val.xloylozlo 3D Corner
bc.constant.val.xloylozhi 3D Corner
bc.constant.val.xloyhizlo 3D Corner
bc.constant.val.xloyhizhi 3D Corner
bc.constant.val.xhiylozlo 3D Corner
bc.constant.val.xhiylozhi 3D Corner
bc.constant.val.xhiyhizlo 3D Corner
bc.constant.val.xhiyhizhi 3D Corner
bc.constant.val.ylozlo 3D Edge
bc.constant.val.ylozhi 3D Edge
bc.constant.val.yhizlo 3D Edge
bc.constant.val.yhizhi 3D Edge
bc.constant.val.zloxlo 3D Edge
bc.constant.val.zloxhi 3D Edge
bc.constant.val.zhixlo 3D Edge
bc.constant.val.zhixhi 3D Edge
bc.constant.val.xloylo 3D Edge / 2D Corner
bc.constant.val.xloyhi 3D Edge / 2D Corner
bc.constant.val.xhiylo 3D Edge / 2D Corner
bc.constant.val.xhiyhi 3D Edge / 2D Corner
bc.constant.val.xlo 3D Face / 2D Edge
bc.constant.val.xhi 3D Face / 2D Edge
bc.constant.val.ylo 3D Face / 2D Edge
bc.constant.val.yhi 3D Face / 2D Edge
bc.constant.val.zlo 3D Face
bc.constant.val.zhi 3D Face
bc.tensiontest.type Tension test type. uniaxial_stress_clamp uniaxial_kolsky uniaxial_stress uniaxial_strain
bc.tensiontest.disp Applied displacement (can be interpolator)
bc.tensiontest.trac Applied traction (can be interpolator)
print_model Print out model variables (if enabled by model) false
rhs.type initial condition for right hand side (body force)

rhs.constant.value Array of constant values. The number of values should equal either 1 or N where N is the number of fab components required
rhs.expression.coord coordinate system to use cartesian polar
rhs.expression.region# Mathematical expression in terms of x,y,z,t (if coord=cartesian) or r,theta,z,t (if coord=polar) and any defined constants. # = 0,1,2,...
rhs.trig.nr Number of real (cosin) waves
rhs.trig.ni Number of imaginary (sin) waves
rhs.trig.dim Spatial dimension
rhs.trig.alpha Multiplier
interval Timestep interval for elastic solves (default - solve every time) 0
max_coarsening_level Maximum multigrid coarsening level (default - none, maximum coarsening) -1
print_residual Whether to include residual output field false
elastic_ref_threshold Whether to refine based on elastic solution 0.01
zero_out_displacement Set this to true to zero out the displacement before each solve. (This is a temporary fix - we need to figure out why this is needed.) false
tstart Time to start doing the elastic solve (by default, start immediately) -1.0
nmodels Number of elastic model varieties 1
model#.C11 Elastic constant 1.68
model#.C12 Elastic constant 1.21
model#.C44 Elastic constant 0.75
model#.anglefmt specify whether using radians or degrees radians degrees
model#.phi1 Bunge Euler angle \(\phi_1\) about x axis 0.0
model#.Phi Bunge Euler angle \(\Phi\) about z axis 0.0
model#.phi2 Bunge Euler angle \(\phi_2\) about x axis 0.0
model#.F0 Eigenstrain
eta_ref_threshold Refinement threshold for eta field 0.01
ref_threshold Refinement threshold for strain gradient 0.01
model_neumann_boundary Explicity impose neumann condition on model at domain boundaries (2d only) false
ic.type Select the initial condition for eta

ic.constant.value Array of constant values. The number of values should equal either 1 or N where N is the number of fab components required
ic.ellipse.x0 Coorinates of ellipse center
ic.ellipse.eps Diffuse boundary thickness 0.0
ic.ellipse.A DxD square matrix defining an ellipse.
ic.ellipse.a If A is not defined, then assume a sphere with radius a
ic.ellipse.number_of_inclusions Number of ellipses
ic.ellipse.center center of the ellipse
ic.ellipse.x0 center of the ellipse
ic.ellipse.A either a vector containing ellipse radii, or a matrix defining the ellipse
ic.ellipse.A Same
ic.ellipse.radius Array of radii [depricated]
ic.ellipse.eps Regularization for smooth boundary
ic.ellipse.invert Flip the inside and the outside
ic.voronoi.number_of_grains Number of grains
ic.voronoi.alpha Value to take in the region [1.0]
ic.voronoi.seed Random seed to use
ic.bmp.filename BMP filename. file path
ic.bmp.fit How to position image in space stretch fitheight fitwidth coord
ic.bmp.coord.lo Location of lower-left corner in the domain
ic.bmp.coord.hi Location of upper-right corner in the domain
ic.bmp.channel Color channel to use r g b R G B
ic.bmp.min Scaling value - minimum 0.0
ic.bmp.max Scaling value - maximum 255.0
ic.png.channel Color channel to use (options: r, R, g, G, b, B, a, A) r g b a R G B A
ic.png.filename BMP filename. file path
ic.png.fit how to position the image stretch fitheight fitwidth coord
ic.png.coord.lo Lower-left coordinates of image in domain
ic.png.coord.hi Upper-right coordinates of image in domain
ic.png.min Desired minimum value to scale pixels by 0.0
ic.png.max Desired maximum value to scale pixels by 255.0
ic.expression.coord coordinate system to use cartesian polar
ic.expression.region# Mathematical expression in terms of x,y,z,t (if coord=cartesian) or r,theta,z,t (if coord=polar) and any defined constants. # = 0,1,2,...
ic.psread.eps Diffuseness of the sphere boundary
ic.psread.filename Location of .xyzr file file path
ic.psread.verbose Verbosity (used in parser only)
ic.psread.mult Coordinate multiplier
ic.psread.invert Coordinate multiplier
ic.psread.x0 Coordinate offset
eta.reset_on_regrid Whether to re-initialize eta when re-gridding occurs. Default is false unless eta ic is set, then default is. true. true
psi.ic.type Select initial condition for psi field

psi.ic.ellipse.x0 Coorinates of ellipse center
psi.ic.ellipse.eps Diffuse boundary thickness 0.0
psi.ic.ellipse.A DxD square matrix defining an ellipse.
psi.ic.ellipse.a If A is not defined, then assume a sphere with radius a
psi.ic.ellipse.number_of_inclusions Number of ellipses
psi.ic.ellipse.center center of the ellipse
psi.ic.ellipse.x0 center of the ellipse
psi.ic.ellipse.A either a vector containing ellipse radii, or a matrix defining the ellipse
psi.ic.ellipse.A Same
psi.ic.ellipse.radius Array of radii [depricated]
psi.ic.ellipse.eps Regularization for smooth boundary
psi.ic.ellipse.invert Flip the inside and the outside
psi.ic.constant.value Array of constant values. The number of values should equal either 1 or N where N is the number of fab components required
psi.ic.expression.coord coordinate system to use cartesian polar
psi.ic.expression.region# Mathematical expression in terms of x,y,z,t (if coord=cartesian) or r,theta,z,t (if coord=polar) and any defined constants. # = 0,1,2,...
psi.ic.psread.eps Diffuseness of the sphere boundary
psi.ic.psread.filename Location of .xyzr file file path
psi.ic.psread.verbose Verbosity (used in parser only)
psi.ic.psread.mult Coordinate multiplier
psi.ic.psread.invert Coordinate multiplier
psi.ic.psread.x0 Coordinate offset
psi.ic.png.channel Color channel to use (options: r, R, g, G, b, B, a, A) r g b a R G B A
psi.ic.png.filename BMP filename. file path
psi.ic.png.fit how to position the image stretch fitheight fitwidth coord
psi.ic.png.coord.lo Lower-left coordinates of image in domain
psi.ic.png.coord.hi Upper-right coordinates of image in domain
psi.ic.png.min Desired minimum value to scale pixels by 0.0
psi.ic.png.max Desired maximum value to scale pixels by 255.0
psi.reset_on_regrid Whether to re-initialize psi when re-gridding occurs. Default is false unless a psi ic is set, then default is true. true
trac_normal.ic.type Read in IC for the "normal traction" field (applied at diffuse boundaries)

trac_normal.ic.ellipse.x0 Coorinates of ellipse center
trac_normal.ic.ellipse.eps Diffuse boundary thickness 0.0
trac_normal.ic.ellipse.A DxD square matrix defining an ellipse.
trac_normal.ic.ellipse.a If A is not defined, then assume a sphere with radius a
trac_normal.ic.ellipse.number_of_inclusions Number of ellipses
trac_normal.ic.ellipse.center center of the ellipse
trac_normal.ic.ellipse.x0 center of the ellipse
trac_normal.ic.ellipse.A either a vector containing ellipse radii, or a matrix defining the ellipse
trac_normal.ic.ellipse.A Same
trac_normal.ic.ellipse.radius Array of radii [depricated]
trac_normal.ic.ellipse.eps Regularization for smooth boundary
trac_normal.ic.ellipse.invert Flip the inside and the outside
trac_normal.ic.constant.value Array of constant values. The number of values should equal either 1 or N where N is the number of fab components required
trac_normal.ic.expression.coord coordinate system to use cartesian polar
trac_normal.ic.expression.region# Mathematical expression in terms of x,y,z,t (if coord=cartesian) or r,theta,z,t (if coord=polar) and any defined constants. # = 0,1,2,...
trac_normal.ic.psread.eps Diffuseness of the sphere boundary
trac_normal.ic.psread.filename Location of .xyzr file file path
trac_normal.ic.psread.verbose Verbosity (used in parser only)
trac_normal.ic.psread.mult Coordinate multiplier
trac_normal.ic.psread.invert Coordinate multiplier
trac_normal.ic.psread.x0 Coordinate offset


Integrator::Mechanics<Model::Solid::Affine::Hexagonal>

Input name Description Value
type Type of mecahnics to use. Static: do full implicit solve. Dynamic: evolve dynamic equations with explicit dynamics Disable: do nothing. disable static dynamic
time_evolving Treat mechanics fields as changing in time. [false] You should use this if you care about other physics driven by the output of this integrator. false
plot_disp Include displacement field in output true
plot_rhs Include right-hand side in output true
plot_psi Include \(\psi\) field in output true
plot_stress Include stress in output true
plot_strain Include strain in output true
viscous.mu_dashpot Dashpot damping (damps velocity) 0.0
viscous.mu_newton Newtonian viscous damping (damps velocity gradient) 0.0
velocity.ic.type Initializer for RHS none expression
bc.type Select the mechanical boundary conditions

bc.constant.type.xloylozlo 3D Corner
bc.constant.type.xloylozhi 3D Corner
bc.constant.type.xloyhizlo 3D Corner
bc.constant.type.xloyhizhi 3D Corner
bc.constant.type.xhiylozlo 3D Corner
bc.constant.type.xhiylozhi 3D Corner
bc.constant.type.xhiyhizlo 3D Corner
bc.constant.type.xhiyhizhi 3D Corner
bc.constant.type.ylozlo 3D Edge
bc.constant.type.ylozhi 3D Edge
bc.constant.type.yhizlo 3D Edge
bc.constant.type.yhizhi 3D Edge
bc.constant.type.zloxlo 3D Edge
bc.constant.type.zloxhi 3D Edge
bc.constant.type.zhixlo 3D Edge
bc.constant.type.zhixhi 3D Edge
bc.constant.type.xloylo 3D Edge / 2D Corner
bc.constant.type.xloyhi 3D Edge / 2D Corner
bc.constant.type.xhiylo 3D Edge / 2D Corner
bc.constant.type.xhiyhi 3D Edge / 2D Corner
bc.constant.type.xlo 3D Face / 2D Edge
bc.constant.type.xhi 3D Face / 2D Edge
bc.constant.type.ylo 3D Face / 2D Edge
bc.constant.type.yhi 3D Face / 2D Edge
bc.constant.type.zlo 3D Face
bc.constant.type.zhi 3D Face
bc.constant.val.xloylozlo 3D Corner
bc.constant.val.xloylozhi 3D Corner
bc.constant.val.xloyhizlo 3D Corner
bc.constant.val.xloyhizhi 3D Corner
bc.constant.val.xhiylozlo 3D Corner
bc.constant.val.xhiylozhi 3D Corner
bc.constant.val.xhiyhizlo 3D Corner
bc.constant.val.xhiyhizhi 3D Corner
bc.constant.val.ylozlo 3D Edge
bc.constant.val.ylozhi 3D Edge
bc.constant.val.yhizlo 3D Edge
bc.constant.val.yhizhi 3D Edge
bc.constant.val.zloxlo 3D Edge
bc.constant.val.zloxhi 3D Edge
bc.constant.val.zhixlo 3D Edge
bc.constant.val.zhixhi 3D Edge
bc.constant.val.xloylo 3D Edge / 2D Corner
bc.constant.val.xloyhi 3D Edge / 2D Corner
bc.constant.val.xhiylo 3D Edge / 2D Corner
bc.constant.val.xhiyhi 3D Edge / 2D Corner
bc.constant.val.xlo 3D Face / 2D Edge
bc.constant.val.xhi 3D Face / 2D Edge
bc.constant.val.ylo 3D Face / 2D Edge
bc.constant.val.yhi 3D Face / 2D Edge
bc.constant.val.zlo 3D Face
bc.constant.val.zhi 3D Face
bc.tensiontest.type Tension test type. uniaxial_stress_clamp uniaxial_kolsky uniaxial_stress uniaxial_strain
bc.tensiontest.disp Applied displacement (can be interpolator)
bc.tensiontest.trac Applied traction (can be interpolator)
print_model Print out model variables (if enabled by model) false
rhs.type initial condition for right hand side (body force)

rhs.constant.value Array of constant values. The number of values should equal either 1 or N where N is the number of fab components required
rhs.expression.coord coordinate system to use cartesian polar
rhs.expression.region# Mathematical expression in terms of x,y,z,t (if coord=cartesian) or r,theta,z,t (if coord=polar) and any defined constants. # = 0,1,2,...
rhs.trig.nr Number of real (cosin) waves
rhs.trig.ni Number of imaginary (sin) waves
rhs.trig.dim Spatial dimension
rhs.trig.alpha Multiplier
interval Timestep interval for elastic solves (default - solve every time) 0
max_coarsening_level Maximum multigrid coarsening level (default - none, maximum coarsening) -1
print_residual Whether to include residual output field false
elastic_ref_threshold Whether to refine based on elastic solution 0.01
zero_out_displacement Set this to true to zero out the displacement before each solve. (This is a temporary fix - we need to figure out why this is needed.) false
tstart Time to start doing the elastic solve (by default, start immediately) -1.0
nmodels Number of elastic model varieties 1
model#.C11 Elastic constant required
model#.C12 Elastic constant required
model#.C13 Elastic constant required
model#.C33 Elastic constant required
model#.C44 Elastic constant required
model#.phi1 Bunge Euler angle \(\phi_1\) 0.0
model#.Phi Bunge Euler angle \(\Phi\) 0.0
model#.phi2 Bunge Euler angle \(\phi_2\) 0.0
model#.F0 Eigenstrain matrix. Can be defined in 2D or 3D.
eta_ref_threshold Refinement threshold for eta field 0.01
ref_threshold Refinement threshold for strain gradient 0.01
model_neumann_boundary Explicity impose neumann condition on model at domain boundaries (2d only) false
ic.type Select the initial condition for eta

ic.constant.value Array of constant values. The number of values should equal either 1 or N where N is the number of fab components required
ic.ellipse.x0 Coorinates of ellipse center
ic.ellipse.eps Diffuse boundary thickness 0.0
ic.ellipse.A DxD square matrix defining an ellipse.
ic.ellipse.a If A is not defined, then assume a sphere with radius a
ic.ellipse.number_of_inclusions Number of ellipses
ic.ellipse.center center of the ellipse
ic.ellipse.x0 center of the ellipse
ic.ellipse.A either a vector containing ellipse radii, or a matrix defining the ellipse
ic.ellipse.A Same
ic.ellipse.radius Array of radii [depricated]
ic.ellipse.eps Regularization for smooth boundary
ic.ellipse.invert Flip the inside and the outside
ic.voronoi.number_of_grains Number of grains
ic.voronoi.alpha Value to take in the region [1.0]
ic.voronoi.seed Random seed to use
ic.bmp.filename BMP filename. file path
ic.bmp.fit How to position image in space stretch fitheight fitwidth coord
ic.bmp.coord.lo Location of lower-left corner in the domain
ic.bmp.coord.hi Location of upper-right corner in the domain
ic.bmp.channel Color channel to use r g b R G B
ic.bmp.min Scaling value - minimum 0.0
ic.bmp.max Scaling value - maximum 255.0
ic.png.channel Color channel to use (options: r, R, g, G, b, B, a, A) r g b a R G B A
ic.png.filename BMP filename. file path
ic.png.fit how to position the image stretch fitheight fitwidth coord
ic.png.coord.lo Lower-left coordinates of image in domain
ic.png.coord.hi Upper-right coordinates of image in domain
ic.png.min Desired minimum value to scale pixels by 0.0
ic.png.max Desired maximum value to scale pixels by 255.0
ic.expression.coord coordinate system to use cartesian polar
ic.expression.region# Mathematical expression in terms of x,y,z,t (if coord=cartesian) or r,theta,z,t (if coord=polar) and any defined constants. # = 0,1,2,...
ic.psread.eps Diffuseness of the sphere boundary
ic.psread.filename Location of .xyzr file file path
ic.psread.verbose Verbosity (used in parser only)
ic.psread.mult Coordinate multiplier
ic.psread.invert Coordinate multiplier
ic.psread.x0 Coordinate offset
eta.reset_on_regrid Whether to re-initialize eta when re-gridding occurs. Default is false unless eta ic is set, then default is. true. true
psi.ic.type Select initial condition for psi field

psi.ic.ellipse.x0 Coorinates of ellipse center
psi.ic.ellipse.eps Diffuse boundary thickness 0.0
psi.ic.ellipse.A DxD square matrix defining an ellipse.
psi.ic.ellipse.a If A is not defined, then assume a sphere with radius a
psi.ic.ellipse.number_of_inclusions Number of ellipses
psi.ic.ellipse.center center of the ellipse
psi.ic.ellipse.x0 center of the ellipse
psi.ic.ellipse.A either a vector containing ellipse radii, or a matrix defining the ellipse
psi.ic.ellipse.A Same
psi.ic.ellipse.radius Array of radii [depricated]
psi.ic.ellipse.eps Regularization for smooth boundary
psi.ic.ellipse.invert Flip the inside and the outside
psi.ic.constant.value Array of constant values. The number of values should equal either 1 or N where N is the number of fab components required
psi.ic.expression.coord coordinate system to use cartesian polar
psi.ic.expression.region# Mathematical expression in terms of x,y,z,t (if coord=cartesian) or r,theta,z,t (if coord=polar) and any defined constants. # = 0,1,2,...
psi.ic.psread.eps Diffuseness of the sphere boundary
psi.ic.psread.filename Location of .xyzr file file path
psi.ic.psread.verbose Verbosity (used in parser only)
psi.ic.psread.mult Coordinate multiplier
psi.ic.psread.invert Coordinate multiplier
psi.ic.psread.x0 Coordinate offset
psi.ic.png.channel Color channel to use (options: r, R, g, G, b, B, a, A) r g b a R G B A
psi.ic.png.filename BMP filename. file path
psi.ic.png.fit how to position the image stretch fitheight fitwidth coord
psi.ic.png.coord.lo Lower-left coordinates of image in domain
psi.ic.png.coord.hi Upper-right coordinates of image in domain
psi.ic.png.min Desired minimum value to scale pixels by 0.0
psi.ic.png.max Desired maximum value to scale pixels by 255.0
psi.reset_on_regrid Whether to re-initialize psi when re-gridding occurs. Default is false unless a psi ic is set, then default is true. true
trac_normal.ic.type Read in IC for the "normal traction" field (applied at diffuse boundaries)

trac_normal.ic.ellipse.x0 Coorinates of ellipse center
trac_normal.ic.ellipse.eps Diffuse boundary thickness 0.0
trac_normal.ic.ellipse.A DxD square matrix defining an ellipse.
trac_normal.ic.ellipse.a If A is not defined, then assume a sphere with radius a
trac_normal.ic.ellipse.number_of_inclusions Number of ellipses
trac_normal.ic.ellipse.center center of the ellipse
trac_normal.ic.ellipse.x0 center of the ellipse
trac_normal.ic.ellipse.A either a vector containing ellipse radii, or a matrix defining the ellipse
trac_normal.ic.ellipse.A Same
trac_normal.ic.ellipse.radius Array of radii [depricated]
trac_normal.ic.ellipse.eps Regularization for smooth boundary
trac_normal.ic.ellipse.invert Flip the inside and the outside
trac_normal.ic.constant.value Array of constant values. The number of values should equal either 1 or N where N is the number of fab components required
trac_normal.ic.expression.coord coordinate system to use cartesian polar
trac_normal.ic.expression.region# Mathematical expression in terms of x,y,z,t (if coord=cartesian) or r,theta,z,t (if coord=polar) and any defined constants. # = 0,1,2,...
trac_normal.ic.psread.eps Diffuseness of the sphere boundary
trac_normal.ic.psread.filename Location of .xyzr file file path
trac_normal.ic.psread.verbose Verbosity (used in parser only)
trac_normal.ic.psread.mult Coordinate multiplier
trac_normal.ic.psread.invert Coordinate multiplier
trac_normal.ic.psread.x0 Coordinate offset


Integrator::Mechanics<Model::Solid::Affine::Isotropic>

Input name Description Value
type Type of mecahnics to use. Static: do full implicit solve. Dynamic: evolve dynamic equations with explicit dynamics Disable: do nothing. disable static dynamic
time_evolving Treat mechanics fields as changing in time. [false] You should use this if you care about other physics driven by the output of this integrator. false
plot_disp Include displacement field in output true
plot_rhs Include right-hand side in output true
plot_psi Include \(\psi\) field in output true
plot_stress Include stress in output true
plot_strain Include strain in output true
viscous.mu_dashpot Dashpot damping (damps velocity) 0.0
viscous.mu_newton Newtonian viscous damping (damps velocity gradient) 0.0
velocity.ic.type Initializer for RHS none expression
bc.type Select the mechanical boundary conditions

bc.constant.type.xloylozlo 3D Corner
bc.constant.type.xloylozhi 3D Corner
bc.constant.type.xloyhizlo 3D Corner
bc.constant.type.xloyhizhi 3D Corner
bc.constant.type.xhiylozlo 3D Corner
bc.constant.type.xhiylozhi 3D Corner
bc.constant.type.xhiyhizlo 3D Corner
bc.constant.type.xhiyhizhi 3D Corner
bc.constant.type.ylozlo 3D Edge
bc.constant.type.ylozhi 3D Edge
bc.constant.type.yhizlo 3D Edge
bc.constant.type.yhizhi 3D Edge
bc.constant.type.zloxlo 3D Edge
bc.constant.type.zloxhi 3D Edge
bc.constant.type.zhixlo 3D Edge
bc.constant.type.zhixhi 3D Edge
bc.constant.type.xloylo 3D Edge / 2D Corner
bc.constant.type.xloyhi 3D Edge / 2D Corner
bc.constant.type.xhiylo 3D Edge / 2D Corner
bc.constant.type.xhiyhi 3D Edge / 2D Corner
bc.constant.type.xlo 3D Face / 2D Edge
bc.constant.type.xhi 3D Face / 2D Edge
bc.constant.type.ylo 3D Face / 2D Edge
bc.constant.type.yhi 3D Face / 2D Edge
bc.constant.type.zlo 3D Face
bc.constant.type.zhi 3D Face
bc.constant.val.xloylozlo 3D Corner
bc.constant.val.xloylozhi 3D Corner
bc.constant.val.xloyhizlo 3D Corner
bc.constant.val.xloyhizhi 3D Corner
bc.constant.val.xhiylozlo 3D Corner
bc.constant.val.xhiylozhi 3D Corner
bc.constant.val.xhiyhizlo 3D Corner
bc.constant.val.xhiyhizhi 3D Corner
bc.constant.val.ylozlo 3D Edge
bc.constant.val.ylozhi 3D Edge
bc.constant.val.yhizlo 3D Edge
bc.constant.val.yhizhi 3D Edge
bc.constant.val.zloxlo 3D Edge
bc.constant.val.zloxhi 3D Edge
bc.constant.val.zhixlo 3D Edge
bc.constant.val.zhixhi 3D Edge
bc.constant.val.xloylo 3D Edge / 2D Corner
bc.constant.val.xloyhi 3D Edge / 2D Corner
bc.constant.val.xhiylo 3D Edge / 2D Corner
bc.constant.val.xhiyhi 3D Edge / 2D Corner
bc.constant.val.xlo 3D Face / 2D Edge
bc.constant.val.xhi 3D Face / 2D Edge
bc.constant.val.ylo 3D Face / 2D Edge
bc.constant.val.yhi 3D Face / 2D Edge
bc.constant.val.zlo 3D Face
bc.constant.val.zhi 3D Face
bc.tensiontest.type Tension test type. uniaxial_stress_clamp uniaxial_kolsky uniaxial_stress uniaxial_strain
bc.tensiontest.disp Applied displacement (can be interpolator)
bc.tensiontest.trac Applied traction (can be interpolator)
print_model Print out model variables (if enabled by model) false
rhs.type initial condition for right hand side (body force)

rhs.constant.value Array of constant values. The number of values should equal either 1 or N where N is the number of fab components required
rhs.expression.coord coordinate system to use cartesian polar
rhs.expression.region# Mathematical expression in terms of x,y,z,t (if coord=cartesian) or r,theta,z,t (if coord=polar) and any defined constants. # = 0,1,2,...
rhs.trig.nr Number of real (cosin) waves
rhs.trig.ni Number of imaginary (sin) waves
rhs.trig.dim Spatial dimension
rhs.trig.alpha Multiplier
interval Timestep interval for elastic solves (default - solve every time) 0
max_coarsening_level Maximum multigrid coarsening level (default - none, maximum coarsening) -1
print_residual Whether to include residual output field false
elastic_ref_threshold Whether to refine based on elastic solution 0.01
zero_out_displacement Set this to true to zero out the displacement before each solve. (This is a temporary fix - we need to figure out why this is needed.) false
tstart Time to start doing the elastic solve (by default, start immediately) -1.0
nmodels Number of elastic model varieties 1
model#.lambda model#.mu model#.E model#.nu model#.kappa Specify exactly 2: required
Specify exactly two of: lame constant \(\lambda\), shear modulus \(\mu\), Young's modulus \(E\), Poisson's ratio \(\nu\), bulk modulus \(\kappa\). \(\mu\) and \(\lambda\) are how the final values are stored.
model#.F0 Eigendeformation gradient
eta_ref_threshold Refinement threshold for eta field 0.01
ref_threshold Refinement threshold for strain gradient 0.01
model_neumann_boundary Explicity impose neumann condition on model at domain boundaries (2d only) false
ic.type Select the initial condition for eta

ic.constant.value Array of constant values. The number of values should equal either 1 or N where N is the number of fab components required
ic.ellipse.x0 Coorinates of ellipse center
ic.ellipse.eps Diffuse boundary thickness 0.0
ic.ellipse.A DxD square matrix defining an ellipse.
ic.ellipse.a If A is not defined, then assume a sphere with radius a
ic.ellipse.number_of_inclusions Number of ellipses
ic.ellipse.center center of the ellipse
ic.ellipse.x0 center of the ellipse
ic.ellipse.A either a vector containing ellipse radii, or a matrix defining the ellipse
ic.ellipse.A Same
ic.ellipse.radius Array of radii [depricated]
ic.ellipse.eps Regularization for smooth boundary
ic.ellipse.invert Flip the inside and the outside
ic.voronoi.number_of_grains Number of grains
ic.voronoi.alpha Value to take in the region [1.0]
ic.voronoi.seed Random seed to use
ic.bmp.filename BMP filename. file path
ic.bmp.fit How to position image in space stretch fitheight fitwidth coord
ic.bmp.coord.lo Location of lower-left corner in the domain
ic.bmp.coord.hi Location of upper-right corner in the domain
ic.bmp.channel Color channel to use r g b R G B
ic.bmp.min Scaling value - minimum 0.0
ic.bmp.max Scaling value - maximum 255.0
ic.png.channel Color channel to use (options: r, R, g, G, b, B, a, A) r g b a R G B A
ic.png.filename BMP filename. file path
ic.png.fit how to position the image stretch fitheight fitwidth coord
ic.png.coord.lo Lower-left coordinates of image in domain
ic.png.coord.hi Upper-right coordinates of image in domain
ic.png.min Desired minimum value to scale pixels by 0.0
ic.png.max Desired maximum value to scale pixels by 255.0
ic.expression.coord coordinate system to use cartesian polar
ic.expression.region# Mathematical expression in terms of x,y,z,t (if coord=cartesian) or r,theta,z,t (if coord=polar) and any defined constants. # = 0,1,2,...
ic.psread.eps Diffuseness of the sphere boundary
ic.psread.filename Location of .xyzr file file path
ic.psread.verbose Verbosity (used in parser only)
ic.psread.mult Coordinate multiplier
ic.psread.invert Coordinate multiplier
ic.psread.x0 Coordinate offset
eta.reset_on_regrid Whether to re-initialize eta when re-gridding occurs. Default is false unless eta ic is set, then default is. true. true
psi.ic.type Select initial condition for psi field

psi.ic.ellipse.x0 Coorinates of ellipse center
psi.ic.ellipse.eps Diffuse boundary thickness 0.0
psi.ic.ellipse.A DxD square matrix defining an ellipse.
psi.ic.ellipse.a If A is not defined, then assume a sphere with radius a
psi.ic.ellipse.number_of_inclusions Number of ellipses
psi.ic.ellipse.center center of the ellipse
psi.ic.ellipse.x0 center of the ellipse
psi.ic.ellipse.A either a vector containing ellipse radii, or a matrix defining the ellipse
psi.ic.ellipse.A Same
psi.ic.ellipse.radius Array of radii [depricated]
psi.ic.ellipse.eps Regularization for smooth boundary
psi.ic.ellipse.invert Flip the inside and the outside
psi.ic.constant.value Array of constant values. The number of values should equal either 1 or N where N is the number of fab components required
psi.ic.expression.coord coordinate system to use cartesian polar
psi.ic.expression.region# Mathematical expression in terms of x,y,z,t (if coord=cartesian) or r,theta,z,t (if coord=polar) and any defined constants. # = 0,1,2,...
psi.ic.psread.eps Diffuseness of the sphere boundary
psi.ic.psread.filename Location of .xyzr file file path
psi.ic.psread.verbose Verbosity (used in parser only)
psi.ic.psread.mult Coordinate multiplier
psi.ic.psread.invert Coordinate multiplier
psi.ic.psread.x0 Coordinate offset
psi.ic.png.channel Color channel to use (options: r, R, g, G, b, B, a, A) r g b a R G B A
psi.ic.png.filename BMP filename. file path
psi.ic.png.fit how to position the image stretch fitheight fitwidth coord
psi.ic.png.coord.lo Lower-left coordinates of image in domain
psi.ic.png.coord.hi Upper-right coordinates of image in domain
psi.ic.png.min Desired minimum value to scale pixels by 0.0
psi.ic.png.max Desired maximum value to scale pixels by 255.0
psi.reset_on_regrid Whether to re-initialize psi when re-gridding occurs. Default is false unless a psi ic is set, then default is true. true
trac_normal.ic.type Read in IC for the "normal traction" field (applied at diffuse boundaries)

trac_normal.ic.ellipse.x0 Coorinates of ellipse center
trac_normal.ic.ellipse.eps Diffuse boundary thickness 0.0
trac_normal.ic.ellipse.A DxD square matrix defining an ellipse.
trac_normal.ic.ellipse.a If A is not defined, then assume a sphere with radius a
trac_normal.ic.ellipse.number_of_inclusions Number of ellipses
trac_normal.ic.ellipse.center center of the ellipse
trac_normal.ic.ellipse.x0 center of the ellipse
trac_normal.ic.ellipse.A either a vector containing ellipse radii, or a matrix defining the ellipse
trac_normal.ic.ellipse.A Same
trac_normal.ic.ellipse.radius Array of radii [depricated]
trac_normal.ic.ellipse.eps Regularization for smooth boundary
trac_normal.ic.ellipse.invert Flip the inside and the outside
trac_normal.ic.constant.value Array of constant values. The number of values should equal either 1 or N where N is the number of fab components required
trac_normal.ic.expression.coord coordinate system to use cartesian polar
trac_normal.ic.expression.region# Mathematical expression in terms of x,y,z,t (if coord=cartesian) or r,theta,z,t (if coord=polar) and any defined constants. # = 0,1,2,...
trac_normal.ic.psread.eps Diffuseness of the sphere boundary
trac_normal.ic.psread.filename Location of .xyzr file file path
trac_normal.ic.psread.verbose Verbosity (used in parser only)
trac_normal.ic.psread.mult Coordinate multiplier
trac_normal.ic.psread.invert Coordinate multiplier
trac_normal.ic.psread.x0 Coordinate offset


Integrator::Mechanics<Model::Solid::Linear::Laplacian>

Input name Description Value
type Type of mecahnics to use. Static: do full implicit solve. Dynamic: evolve dynamic equations with explicit dynamics Disable: do nothing. disable static dynamic
time_evolving Treat mechanics fields as changing in time. [false] You should use this if you care about other physics driven by the output of this integrator. false
plot_disp Include displacement field in output true
plot_rhs Include right-hand side in output true
plot_psi Include \(\psi\) field in output true
plot_stress Include stress in output true
plot_strain Include strain in output true
viscous.mu_dashpot Dashpot damping (damps velocity) 0.0
viscous.mu_newton Newtonian viscous damping (damps velocity gradient) 0.0
velocity.ic.type Initializer for RHS none expression
bc.type Select the mechanical boundary conditions

bc.constant.type.xloylozlo 3D Corner
bc.constant.type.xloylozhi 3D Corner
bc.constant.type.xloyhizlo 3D Corner
bc.constant.type.xloyhizhi 3D Corner
bc.constant.type.xhiylozlo 3D Corner
bc.constant.type.xhiylozhi 3D Corner
bc.constant.type.xhiyhizlo 3D Corner
bc.constant.type.xhiyhizhi 3D Corner
bc.constant.type.ylozlo 3D Edge
bc.constant.type.ylozhi 3D Edge
bc.constant.type.yhizlo 3D Edge
bc.constant.type.yhizhi 3D Edge
bc.constant.type.zloxlo 3D Edge
bc.constant.type.zloxhi 3D Edge
bc.constant.type.zhixlo 3D Edge
bc.constant.type.zhixhi 3D Edge
bc.constant.type.xloylo 3D Edge / 2D Corner
bc.constant.type.xloyhi 3D Edge / 2D Corner
bc.constant.type.xhiylo 3D Edge / 2D Corner
bc.constant.type.xhiyhi 3D Edge / 2D Corner
bc.constant.type.xlo 3D Face / 2D Edge
bc.constant.type.xhi 3D Face / 2D Edge
bc.constant.type.ylo 3D Face / 2D Edge
bc.constant.type.yhi 3D Face / 2D Edge
bc.constant.type.zlo 3D Face
bc.constant.type.zhi 3D Face
bc.constant.val.xloylozlo 3D Corner
bc.constant.val.xloylozhi 3D Corner
bc.constant.val.xloyhizlo 3D Corner
bc.constant.val.xloyhizhi 3D Corner
bc.constant.val.xhiylozlo 3D Corner
bc.constant.val.xhiylozhi 3D Corner
bc.constant.val.xhiyhizlo 3D Corner
bc.constant.val.xhiyhizhi 3D Corner
bc.constant.val.ylozlo 3D Edge
bc.constant.val.ylozhi 3D Edge
bc.constant.val.yhizlo 3D Edge
bc.constant.val.yhizhi 3D Edge
bc.constant.val.zloxlo 3D Edge
bc.constant.val.zloxhi 3D Edge
bc.constant.val.zhixlo 3D Edge
bc.constant.val.zhixhi 3D Edge
bc.constant.val.xloylo 3D Edge / 2D Corner
bc.constant.val.xloyhi 3D Edge / 2D Corner
bc.constant.val.xhiylo 3D Edge / 2D Corner
bc.constant.val.xhiyhi 3D Edge / 2D Corner
bc.constant.val.xlo 3D Face / 2D Edge
bc.constant.val.xhi 3D Face / 2D Edge
bc.constant.val.ylo 3D Face / 2D Edge
bc.constant.val.yhi 3D Face / 2D Edge
bc.constant.val.zlo 3D Face
bc.constant.val.zhi 3D Face
bc.tensiontest.type Tension test type. uniaxial_stress_clamp uniaxial_kolsky uniaxial_stress uniaxial_strain
bc.tensiontest.disp Applied displacement (can be interpolator)
bc.tensiontest.trac Applied traction (can be interpolator)
print_model Print out model variables (if enabled by model) false
rhs.type initial condition for right hand side (body force)

rhs.constant.value Array of constant values. The number of values should equal either 1 or N where N is the number of fab components required
rhs.expression.coord coordinate system to use cartesian polar
rhs.expression.region# Mathematical expression in terms of x,y,z,t (if coord=cartesian) or r,theta,z,t (if coord=polar) and any defined constants. # = 0,1,2,...
rhs.trig.nr Number of real (cosin) waves
rhs.trig.ni Number of imaginary (sin) waves
rhs.trig.dim Spatial dimension
rhs.trig.alpha Multiplier
interval Timestep interval for elastic solves (default - solve every time) 0
max_coarsening_level Maximum multigrid coarsening level (default - none, maximum coarsening) -1
print_residual Whether to include residual output field false
elastic_ref_threshold Whether to refine based on elastic solution 0.01
zero_out_displacement Set this to true to zero out the displacement before each solve. (This is a temporary fix - we need to figure out why this is needed.) false
tstart Time to start doing the elastic solve (by default, start immediately) -1.0
nmodels Number of elastic model varieties 1
model#.alpha Coefficient for the Laplacian 1.0
eta_ref_threshold Refinement threshold for eta field 0.01
ref_threshold Refinement threshold for strain gradient 0.01
model_neumann_boundary Explicity impose neumann condition on model at domain boundaries (2d only) false
ic.type Select the initial condition for eta

ic.constant.value Array of constant values. The number of values should equal either 1 or N where N is the number of fab components required
ic.ellipse.x0 Coorinates of ellipse center
ic.ellipse.eps Diffuse boundary thickness 0.0
ic.ellipse.A DxD square matrix defining an ellipse.
ic.ellipse.a If A is not defined, then assume a sphere with radius a
ic.ellipse.number_of_inclusions Number of ellipses
ic.ellipse.center center of the ellipse
ic.ellipse.x0 center of the ellipse
ic.ellipse.A either a vector containing ellipse radii, or a matrix defining the ellipse
ic.ellipse.A Same
ic.ellipse.radius Array of radii [depricated]
ic.ellipse.eps Regularization for smooth boundary
ic.ellipse.invert Flip the inside and the outside
ic.voronoi.number_of_grains Number of grains
ic.voronoi.alpha Value to take in the region [1.0]
ic.voronoi.seed Random seed to use
ic.bmp.filename BMP filename. file path
ic.bmp.fit How to position image in space stretch fitheight fitwidth coord
ic.bmp.coord.lo Location of lower-left corner in the domain
ic.bmp.coord.hi Location of upper-right corner in the domain
ic.bmp.channel Color channel to use r g b R G B
ic.bmp.min Scaling value - minimum 0.0
ic.bmp.max Scaling value - maximum 255.0
ic.png.channel Color channel to use (options: r, R, g, G, b, B, a, A) r g b a R G B A
ic.png.filename BMP filename. file path
ic.png.fit how to position the image stretch fitheight fitwidth coord
ic.png.coord.lo Lower-left coordinates of image in domain
ic.png.coord.hi Upper-right coordinates of image in domain
ic.png.min Desired minimum value to scale pixels by 0.0
ic.png.max Desired maximum value to scale pixels by 255.0
ic.expression.coord coordinate system to use cartesian polar
ic.expression.region# Mathematical expression in terms of x,y,z,t (if coord=cartesian) or r,theta,z,t (if coord=polar) and any defined constants. # = 0,1,2,...
ic.psread.eps Diffuseness of the sphere boundary
ic.psread.filename Location of .xyzr file file path
ic.psread.verbose Verbosity (used in parser only)
ic.psread.mult Coordinate multiplier
ic.psread.invert Coordinate multiplier
ic.psread.x0 Coordinate offset
eta.reset_on_regrid Whether to re-initialize eta when re-gridding occurs. Default is false unless eta ic is set, then default is. true. true
psi.ic.type Select initial condition for psi field

psi.ic.ellipse.x0 Coorinates of ellipse center
psi.ic.ellipse.eps Diffuse boundary thickness 0.0
psi.ic.ellipse.A DxD square matrix defining an ellipse.
psi.ic.ellipse.a If A is not defined, then assume a sphere with radius a
psi.ic.ellipse.number_of_inclusions Number of ellipses
psi.ic.ellipse.center center of the ellipse
psi.ic.ellipse.x0 center of the ellipse
psi.ic.ellipse.A either a vector containing ellipse radii, or a matrix defining the ellipse
psi.ic.ellipse.A Same
psi.ic.ellipse.radius Array of radii [depricated]
psi.ic.ellipse.eps Regularization for smooth boundary
psi.ic.ellipse.invert Flip the inside and the outside
psi.ic.constant.value Array of constant values. The number of values should equal either 1 or N where N is the number of fab components required
psi.ic.expression.coord coordinate system to use cartesian polar
psi.ic.expression.region# Mathematical expression in terms of x,y,z,t (if coord=cartesian) or r,theta,z,t (if coord=polar) and any defined constants. # = 0,1,2,...
psi.ic.psread.eps Diffuseness of the sphere boundary
psi.ic.psread.filename Location of .xyzr file file path
psi.ic.psread.verbose Verbosity (used in parser only)
psi.ic.psread.mult Coordinate multiplier
psi.ic.psread.invert Coordinate multiplier
psi.ic.psread.x0 Coordinate offset
psi.ic.png.channel Color channel to use (options: r, R, g, G, b, B, a, A) r g b a R G B A
psi.ic.png.filename BMP filename. file path
psi.ic.png.fit how to position the image stretch fitheight fitwidth coord
psi.ic.png.coord.lo Lower-left coordinates of image in domain
psi.ic.png.coord.hi Upper-right coordinates of image in domain
psi.ic.png.min Desired minimum value to scale pixels by 0.0
psi.ic.png.max Desired maximum value to scale pixels by 255.0
psi.reset_on_regrid Whether to re-initialize psi when re-gridding occurs. Default is false unless a psi ic is set, then default is true. true
trac_normal.ic.type Read in IC for the "normal traction" field (applied at diffuse boundaries)

trac_normal.ic.ellipse.x0 Coorinates of ellipse center
trac_normal.ic.ellipse.eps Diffuse boundary thickness 0.0
trac_normal.ic.ellipse.A DxD square matrix defining an ellipse.
trac_normal.ic.ellipse.a If A is not defined, then assume a sphere with radius a
trac_normal.ic.ellipse.number_of_inclusions Number of ellipses
trac_normal.ic.ellipse.center center of the ellipse
trac_normal.ic.ellipse.x0 center of the ellipse
trac_normal.ic.ellipse.A either a vector containing ellipse radii, or a matrix defining the ellipse
trac_normal.ic.ellipse.A Same
trac_normal.ic.ellipse.radius Array of radii [depricated]
trac_normal.ic.ellipse.eps Regularization for smooth boundary
trac_normal.ic.ellipse.invert Flip the inside and the outside
trac_normal.ic.constant.value Array of constant values. The number of values should equal either 1 or N where N is the number of fab components required
trac_normal.ic.expression.coord coordinate system to use cartesian polar
trac_normal.ic.expression.region# Mathematical expression in terms of x,y,z,t (if coord=cartesian) or r,theta,z,t (if coord=polar) and any defined constants. # = 0,1,2,...
trac_normal.ic.psread.eps Diffuseness of the sphere boundary
trac_normal.ic.psread.filename Location of .xyzr file file path
trac_normal.ic.psread.verbose Verbosity (used in parser only)
trac_normal.ic.psread.mult Coordinate multiplier
trac_normal.ic.psread.invert Coordinate multiplier
trac_normal.ic.psread.x0 Coordinate offset


Integrator::Mechanics<Model::Solid::Finite::NeoHookean>

Input name Description Value
type Type of mecahnics to use. Static: do full implicit solve. Dynamic: evolve dynamic equations with explicit dynamics Disable: do nothing. disable static dynamic
time_evolving Treat mechanics fields as changing in time. [false] You should use this if you care about other physics driven by the output of this integrator. false
plot_disp Include displacement field in output true
plot_rhs Include right-hand side in output true
plot_psi Include \(\psi\) field in output true
plot_stress Include stress in output true
plot_strain Include strain in output true
viscous.mu_dashpot Dashpot damping (damps velocity) 0.0
viscous.mu_newton Newtonian viscous damping (damps velocity gradient) 0.0
velocity.ic.type Initializer for RHS none expression
bc.type Select the mechanical boundary conditions

bc.constant.type.xloylozlo 3D Corner
bc.constant.type.xloylozhi 3D Corner
bc.constant.type.xloyhizlo 3D Corner
bc.constant.type.xloyhizhi 3D Corner
bc.constant.type.xhiylozlo 3D Corner
bc.constant.type.xhiylozhi 3D Corner
bc.constant.type.xhiyhizlo 3D Corner
bc.constant.type.xhiyhizhi 3D Corner
bc.constant.type.ylozlo 3D Edge
bc.constant.type.ylozhi 3D Edge
bc.constant.type.yhizlo 3D Edge
bc.constant.type.yhizhi 3D Edge
bc.constant.type.zloxlo 3D Edge
bc.constant.type.zloxhi 3D Edge
bc.constant.type.zhixlo 3D Edge
bc.constant.type.zhixhi 3D Edge
bc.constant.type.xloylo 3D Edge / 2D Corner
bc.constant.type.xloyhi 3D Edge / 2D Corner
bc.constant.type.xhiylo 3D Edge / 2D Corner
bc.constant.type.xhiyhi 3D Edge / 2D Corner
bc.constant.type.xlo 3D Face / 2D Edge
bc.constant.type.xhi 3D Face / 2D Edge
bc.constant.type.ylo 3D Face / 2D Edge
bc.constant.type.yhi 3D Face / 2D Edge
bc.constant.type.zlo 3D Face
bc.constant.type.zhi 3D Face
bc.constant.val.xloylozlo 3D Corner
bc.constant.val.xloylozhi 3D Corner
bc.constant.val.xloyhizlo 3D Corner
bc.constant.val.xloyhizhi 3D Corner
bc.constant.val.xhiylozlo 3D Corner
bc.constant.val.xhiylozhi 3D Corner
bc.constant.val.xhiyhizlo 3D Corner
bc.constant.val.xhiyhizhi 3D Corner
bc.constant.val.ylozlo 3D Edge
bc.constant.val.ylozhi 3D Edge
bc.constant.val.yhizlo 3D Edge
bc.constant.val.yhizhi 3D Edge
bc.constant.val.zloxlo 3D Edge
bc.constant.val.zloxhi 3D Edge
bc.constant.val.zhixlo 3D Edge
bc.constant.val.zhixhi 3D Edge
bc.constant.val.xloylo 3D Edge / 2D Corner
bc.constant.val.xloyhi 3D Edge / 2D Corner
bc.constant.val.xhiylo 3D Edge / 2D Corner
bc.constant.val.xhiyhi 3D Edge / 2D Corner
bc.constant.val.xlo 3D Face / 2D Edge
bc.constant.val.xhi 3D Face / 2D Edge
bc.constant.val.ylo 3D Face / 2D Edge
bc.constant.val.yhi 3D Face / 2D Edge
bc.constant.val.zlo 3D Face
bc.constant.val.zhi 3D Face
bc.tensiontest.type Tension test type. uniaxial_stress_clamp uniaxial_kolsky uniaxial_stress uniaxial_strain
bc.tensiontest.disp Applied displacement (can be interpolator)
bc.tensiontest.trac Applied traction (can be interpolator)
print_model Print out model variables (if enabled by model) false
rhs.type initial condition for right hand side (body force)

rhs.constant.value Array of constant values. The number of values should equal either 1 or N where N is the number of fab components required
rhs.expression.coord coordinate system to use cartesian polar
rhs.expression.region# Mathematical expression in terms of x,y,z,t (if coord=cartesian) or r,theta,z,t (if coord=polar) and any defined constants. # = 0,1,2,...
rhs.trig.nr Number of real (cosin) waves
rhs.trig.ni Number of imaginary (sin) waves
rhs.trig.dim Spatial dimension
rhs.trig.alpha Multiplier
interval Timestep interval for elastic solves (default - solve every time) 0
max_coarsening_level Maximum multigrid coarsening level (default - none, maximum coarsening) -1
print_residual Whether to include residual output field false
elastic_ref_threshold Whether to refine based on elastic solution 0.01
zero_out_displacement Set this to true to zero out the displacement before each solve. (This is a temporary fix - we need to figure out why this is needed.) false
tstart Time to start doing the elastic solve (by default, start immediately) -1.0
nmodels Number of elastic model varieties 1
model#.lambda model#.mu model#.E model#.nu model#.kappa Specify exactly 2: required
Lame constant \(\lambda\), shear modulus \(\mu\), Young's modulus \(E\), Poisson's ratio \(\nu\), bulk modulus \(K\). You can currently specify (mu and kappa), (lambda and mu), or (E and nu).
eta_ref_threshold Refinement threshold for eta field 0.01
ref_threshold Refinement threshold for strain gradient 0.01
model_neumann_boundary Explicity impose neumann condition on model at domain boundaries (2d only) false
ic.type Select the initial condition for eta

ic.constant.value Array of constant values. The number of values should equal either 1 or N where N is the number of fab components required
ic.ellipse.x0 Coorinates of ellipse center
ic.ellipse.eps Diffuse boundary thickness 0.0
ic.ellipse.A DxD square matrix defining an ellipse.
ic.ellipse.a If A is not defined, then assume a sphere with radius a
ic.ellipse.number_of_inclusions Number of ellipses
ic.ellipse.center center of the ellipse
ic.ellipse.x0 center of the ellipse
ic.ellipse.A either a vector containing ellipse radii, or a matrix defining the ellipse
ic.ellipse.A Same
ic.ellipse.radius Array of radii [depricated]
ic.ellipse.eps Regularization for smooth boundary
ic.ellipse.invert Flip the inside and the outside
ic.voronoi.number_of_grains Number of grains
ic.voronoi.alpha Value to take in the region [1.0]
ic.voronoi.seed Random seed to use
ic.bmp.filename BMP filename. file path
ic.bmp.fit How to position image in space stretch fitheight fitwidth coord
ic.bmp.coord.lo Location of lower-left corner in the domain
ic.bmp.coord.hi Location of upper-right corner in the domain
ic.bmp.channel Color channel to use r g b R G B
ic.bmp.min Scaling value - minimum 0.0
ic.bmp.max Scaling value - maximum 255.0
ic.png.channel Color channel to use (options: r, R, g, G, b, B, a, A) r g b a R G B A
ic.png.filename BMP filename. file path
ic.png.fit how to position the image stretch fitheight fitwidth coord
ic.png.coord.lo Lower-left coordinates of image in domain
ic.png.coord.hi Upper-right coordinates of image in domain
ic.png.min Desired minimum value to scale pixels by 0.0
ic.png.max Desired maximum value to scale pixels by 255.0
ic.expression.coord coordinate system to use cartesian polar
ic.expression.region# Mathematical expression in terms of x,y,z,t (if coord=cartesian) or r,theta,z,t (if coord=polar) and any defined constants. # = 0,1,2,...
ic.psread.eps Diffuseness of the sphere boundary
ic.psread.filename Location of .xyzr file file path
ic.psread.verbose Verbosity (used in parser only)
ic.psread.mult Coordinate multiplier
ic.psread.invert Coordinate multiplier
ic.psread.x0 Coordinate offset
eta.reset_on_regrid Whether to re-initialize eta when re-gridding occurs. Default is false unless eta ic is set, then default is. true. true
psi.ic.type Select initial condition for psi field

psi.ic.ellipse.x0 Coorinates of ellipse center
psi.ic.ellipse.eps Diffuse boundary thickness 0.0
psi.ic.ellipse.A DxD square matrix defining an ellipse.
psi.ic.ellipse.a If A is not defined, then assume a sphere with radius a
psi.ic.ellipse.number_of_inclusions Number of ellipses
psi.ic.ellipse.center center of the ellipse
psi.ic.ellipse.x0 center of the ellipse
psi.ic.ellipse.A either a vector containing ellipse radii, or a matrix defining the ellipse
psi.ic.ellipse.A Same
psi.ic.ellipse.radius Array of radii [depricated]
psi.ic.ellipse.eps Regularization for smooth boundary
psi.ic.ellipse.invert Flip the inside and the outside
psi.ic.constant.value Array of constant values. The number of values should equal either 1 or N where N is the number of fab components required
psi.ic.expression.coord coordinate system to use cartesian polar
psi.ic.expression.region# Mathematical expression in terms of x,y,z,t (if coord=cartesian) or r,theta,z,t (if coord=polar) and any defined constants. # = 0,1,2,...
psi.ic.psread.eps Diffuseness of the sphere boundary
psi.ic.psread.filename Location of .xyzr file file path
psi.ic.psread.verbose Verbosity (used in parser only)
psi.ic.psread.mult Coordinate multiplier
psi.ic.psread.invert Coordinate multiplier
psi.ic.psread.x0 Coordinate offset
psi.ic.png.channel Color channel to use (options: r, R, g, G, b, B, a, A) r g b a R G B A
psi.ic.png.filename BMP filename. file path
psi.ic.png.fit how to position the image stretch fitheight fitwidth coord
psi.ic.png.coord.lo Lower-left coordinates of image in domain
psi.ic.png.coord.hi Upper-right coordinates of image in domain
psi.ic.png.min Desired minimum value to scale pixels by 0.0
psi.ic.png.max Desired maximum value to scale pixels by 255.0
psi.reset_on_regrid Whether to re-initialize psi when re-gridding occurs. Default is false unless a psi ic is set, then default is true. true
trac_normal.ic.type Read in IC for the "normal traction" field (applied at diffuse boundaries)

trac_normal.ic.ellipse.x0 Coorinates of ellipse center
trac_normal.ic.ellipse.eps Diffuse boundary thickness 0.0
trac_normal.ic.ellipse.A DxD square matrix defining an ellipse.
trac_normal.ic.ellipse.a If A is not defined, then assume a sphere with radius a
trac_normal.ic.ellipse.number_of_inclusions Number of ellipses
trac_normal.ic.ellipse.center center of the ellipse
trac_normal.ic.ellipse.x0 center of the ellipse
trac_normal.ic.ellipse.A either a vector containing ellipse radii, or a matrix defining the ellipse
trac_normal.ic.ellipse.A Same
trac_normal.ic.ellipse.radius Array of radii [depricated]
trac_normal.ic.ellipse.eps Regularization for smooth boundary
trac_normal.ic.ellipse.invert Flip the inside and the outside
trac_normal.ic.constant.value Array of constant values. The number of values should equal either 1 or N where N is the number of fab components required
trac_normal.ic.expression.coord coordinate system to use cartesian polar
trac_normal.ic.expression.region# Mathematical expression in terms of x,y,z,t (if coord=cartesian) or r,theta,z,t (if coord=polar) and any defined constants. # = 0,1,2,...
trac_normal.ic.psread.eps Diffuseness of the sphere boundary
trac_normal.ic.psread.filename Location of .xyzr file file path
trac_normal.ic.psread.verbose Verbosity (used in parser only)
trac_normal.ic.psread.mult Coordinate multiplier
trac_normal.ic.psread.invert Coordinate multiplier
trac_normal.ic.psread.x0 Coordinate offset


Integrator::Mechanics<Model::Solid::Finite::NeoHookeanPredeformed>

Input name Description Value
type Type of mecahnics to use. Static: do full implicit solve. Dynamic: evolve dynamic equations with explicit dynamics Disable: do nothing. disable static dynamic
time_evolving Treat mechanics fields as changing in time. [false] You should use this if you care about other physics driven by the output of this integrator. false
plot_disp Include displacement field in output true
plot_rhs Include right-hand side in output true
plot_psi Include \(\psi\) field in output true
plot_stress Include stress in output true
plot_strain Include strain in output true
viscous.mu_dashpot Dashpot damping (damps velocity) 0.0
viscous.mu_newton Newtonian viscous damping (damps velocity gradient) 0.0
velocity.ic.type Initializer for RHS none expression
bc.type Select the mechanical boundary conditions

bc.constant.type.xloylozlo 3D Corner
bc.constant.type.xloylozhi 3D Corner
bc.constant.type.xloyhizlo 3D Corner
bc.constant.type.xloyhizhi 3D Corner
bc.constant.type.xhiylozlo 3D Corner
bc.constant.type.xhiylozhi 3D Corner
bc.constant.type.xhiyhizlo 3D Corner
bc.constant.type.xhiyhizhi 3D Corner
bc.constant.type.ylozlo 3D Edge
bc.constant.type.ylozhi 3D Edge
bc.constant.type.yhizlo 3D Edge
bc.constant.type.yhizhi 3D Edge
bc.constant.type.zloxlo 3D Edge
bc.constant.type.zloxhi 3D Edge
bc.constant.type.zhixlo 3D Edge
bc.constant.type.zhixhi 3D Edge
bc.constant.type.xloylo 3D Edge / 2D Corner
bc.constant.type.xloyhi 3D Edge / 2D Corner
bc.constant.type.xhiylo 3D Edge / 2D Corner
bc.constant.type.xhiyhi 3D Edge / 2D Corner
bc.constant.type.xlo 3D Face / 2D Edge
bc.constant.type.xhi 3D Face / 2D Edge
bc.constant.type.ylo 3D Face / 2D Edge
bc.constant.type.yhi 3D Face / 2D Edge
bc.constant.type.zlo 3D Face
bc.constant.type.zhi 3D Face
bc.constant.val.xloylozlo 3D Corner
bc.constant.val.xloylozhi 3D Corner
bc.constant.val.xloyhizlo 3D Corner
bc.constant.val.xloyhizhi 3D Corner
bc.constant.val.xhiylozlo 3D Corner
bc.constant.val.xhiylozhi 3D Corner
bc.constant.val.xhiyhizlo 3D Corner
bc.constant.val.xhiyhizhi 3D Corner
bc.constant.val.ylozlo 3D Edge
bc.constant.val.ylozhi 3D Edge
bc.constant.val.yhizlo 3D Edge
bc.constant.val.yhizhi 3D Edge
bc.constant.val.zloxlo 3D Edge
bc.constant.val.zloxhi 3D Edge
bc.constant.val.zhixlo 3D Edge
bc.constant.val.zhixhi 3D Edge
bc.constant.val.xloylo 3D Edge / 2D Corner
bc.constant.val.xloyhi 3D Edge / 2D Corner
bc.constant.val.xhiylo 3D Edge / 2D Corner
bc.constant.val.xhiyhi 3D Edge / 2D Corner
bc.constant.val.xlo 3D Face / 2D Edge
bc.constant.val.xhi 3D Face / 2D Edge
bc.constant.val.ylo 3D Face / 2D Edge
bc.constant.val.yhi 3D Face / 2D Edge
bc.constant.val.zlo 3D Face
bc.constant.val.zhi 3D Face
bc.tensiontest.type Tension test type. uniaxial_stress_clamp uniaxial_kolsky uniaxial_stress uniaxial_strain
bc.tensiontest.disp Applied displacement (can be interpolator)
bc.tensiontest.trac Applied traction (can be interpolator)
print_model Print out model variables (if enabled by model) false
rhs.type initial condition for right hand side (body force)

rhs.constant.value Array of constant values. The number of values should equal either 1 or N where N is the number of fab components required
rhs.expression.coord coordinate system to use cartesian polar
rhs.expression.region# Mathematical expression in terms of x,y,z,t (if coord=cartesian) or r,theta,z,t (if coord=polar) and any defined constants. # = 0,1,2,...
rhs.trig.nr Number of real (cosin) waves
rhs.trig.ni Number of imaginary (sin) waves
rhs.trig.dim Spatial dimension
rhs.trig.alpha Multiplier
interval Timestep interval for elastic solves (default - solve every time) 0
max_coarsening_level Maximum multigrid coarsening level (default - none, maximum coarsening) -1
print_residual Whether to include residual output field false
elastic_ref_threshold Whether to refine based on elastic solution 0.01
zero_out_displacement Set this to true to zero out the displacement before each solve. (This is a temporary fix - we need to figure out why this is needed.) false
tstart Time to start doing the elastic solve (by default, start immediately) -1.0
nmodels Number of elastic model varieties 1
model#.lambda model#.mu model#.E model#.nu model#.kappa Specify exactly 2: required
Lame constant \(\lambda\), shear modulus \(\mu\), Young's modulus \(E\), Poisson's ratio \(\nu\), bulk modulus \(K\). You can currently specify (mu and kappa), (lambda and mu), or (E and nu).
model#.F0 Large-deformation eigendeformation (Identity = no deformation)
model#.eps0 Small-deformation eigendeformation (Zero = no deformation)
eta_ref_threshold Refinement threshold for eta field 0.01
ref_threshold Refinement threshold for strain gradient 0.01
model_neumann_boundary Explicity impose neumann condition on model at domain boundaries (2d only) false
ic.type Select the initial condition for eta

ic.constant.value Array of constant values. The number of values should equal either 1 or N where N is the number of fab components required
ic.ellipse.x0 Coorinates of ellipse center
ic.ellipse.eps Diffuse boundary thickness 0.0
ic.ellipse.A DxD square matrix defining an ellipse.
ic.ellipse.a If A is not defined, then assume a sphere with radius a
ic.ellipse.number_of_inclusions Number of ellipses
ic.ellipse.center center of the ellipse
ic.ellipse.x0 center of the ellipse
ic.ellipse.A either a vector containing ellipse radii, or a matrix defining the ellipse
ic.ellipse.A Same
ic.ellipse.radius Array of radii [depricated]
ic.ellipse.eps Regularization for smooth boundary
ic.ellipse.invert Flip the inside and the outside
ic.voronoi.number_of_grains Number of grains
ic.voronoi.alpha Value to take in the region [1.0]
ic.voronoi.seed Random seed to use
ic.bmp.filename BMP filename. file path
ic.bmp.fit How to position image in space stretch fitheight fitwidth coord
ic.bmp.coord.lo Location of lower-left corner in the domain
ic.bmp.coord.hi Location of upper-right corner in the domain
ic.bmp.channel Color channel to use r g b R G B
ic.bmp.min Scaling value - minimum 0.0
ic.bmp.max Scaling value - maximum 255.0
ic.png.channel Color channel to use (options: r, R, g, G, b, B, a, A) r g b a R G B A
ic.png.filename BMP filename. file path
ic.png.fit how to position the image stretch fitheight fitwidth coord
ic.png.coord.lo Lower-left coordinates of image in domain
ic.png.coord.hi Upper-right coordinates of image in domain
ic.png.min Desired minimum value to scale pixels by 0.0
ic.png.max Desired maximum value to scale pixels by 255.0
ic.expression.coord coordinate system to use cartesian polar
ic.expression.region# Mathematical expression in terms of x,y,z,t (if coord=cartesian) or r,theta,z,t (if coord=polar) and any defined constants. # = 0,1,2,...
ic.psread.eps Diffuseness of the sphere boundary
ic.psread.filename Location of .xyzr file file path
ic.psread.verbose Verbosity (used in parser only)
ic.psread.mult Coordinate multiplier
ic.psread.invert Coordinate multiplier
ic.psread.x0 Coordinate offset
eta.reset_on_regrid Whether to re-initialize eta when re-gridding occurs. Default is false unless eta ic is set, then default is. true. true
psi.ic.type Select initial condition for psi field

psi.ic.ellipse.x0 Coorinates of ellipse center
psi.ic.ellipse.eps Diffuse boundary thickness 0.0
psi.ic.ellipse.A DxD square matrix defining an ellipse.
psi.ic.ellipse.a If A is not defined, then assume a sphere with radius a
psi.ic.ellipse.number_of_inclusions Number of ellipses
psi.ic.ellipse.center center of the ellipse
psi.ic.ellipse.x0 center of the ellipse
psi.ic.ellipse.A either a vector containing ellipse radii, or a matrix defining the ellipse
psi.ic.ellipse.A Same
psi.ic.ellipse.radius Array of radii [depricated]
psi.ic.ellipse.eps Regularization for smooth boundary
psi.ic.ellipse.invert Flip the inside and the outside
psi.ic.constant.value Array of constant values. The number of values should equal either 1 or N where N is the number of fab components required
psi.ic.expression.coord coordinate system to use cartesian polar
psi.ic.expression.region# Mathematical expression in terms of x,y,z,t (if coord=cartesian) or r,theta,z,t (if coord=polar) and any defined constants. # = 0,1,2,...
psi.ic.psread.eps Diffuseness of the sphere boundary
psi.ic.psread.filename Location of .xyzr file file path
psi.ic.psread.verbose Verbosity (used in parser only)
psi.ic.psread.mult Coordinate multiplier
psi.ic.psread.invert Coordinate multiplier
psi.ic.psread.x0 Coordinate offset
psi.ic.png.channel Color channel to use (options: r, R, g, G, b, B, a, A) r g b a R G B A
psi.ic.png.filename BMP filename. file path
psi.ic.png.fit how to position the image stretch fitheight fitwidth coord
psi.ic.png.coord.lo Lower-left coordinates of image in domain
psi.ic.png.coord.hi Upper-right coordinates of image in domain
psi.ic.png.min Desired minimum value to scale pixels by 0.0
psi.ic.png.max Desired maximum value to scale pixels by 255.0
psi.reset_on_regrid Whether to re-initialize psi when re-gridding occurs. Default is false unless a psi ic is set, then default is true. true
trac_normal.ic.type Read in IC for the "normal traction" field (applied at diffuse boundaries)

trac_normal.ic.ellipse.x0 Coorinates of ellipse center
trac_normal.ic.ellipse.eps Diffuse boundary thickness 0.0
trac_normal.ic.ellipse.A DxD square matrix defining an ellipse.
trac_normal.ic.ellipse.a If A is not defined, then assume a sphere with radius a
trac_normal.ic.ellipse.number_of_inclusions Number of ellipses
trac_normal.ic.ellipse.center center of the ellipse
trac_normal.ic.ellipse.x0 center of the ellipse
trac_normal.ic.ellipse.A either a vector containing ellipse radii, or a matrix defining the ellipse
trac_normal.ic.ellipse.A Same
trac_normal.ic.ellipse.radius Array of radii [depricated]
trac_normal.ic.ellipse.eps Regularization for smooth boundary
trac_normal.ic.ellipse.invert Flip the inside and the outside
trac_normal.ic.constant.value Array of constant values. The number of values should equal either 1 or N where N is the number of fab components required
trac_normal.ic.expression.coord coordinate system to use cartesian polar
trac_normal.ic.expression.region# Mathematical expression in terms of x,y,z,t (if coord=cartesian) or r,theta,z,t (if coord=polar) and any defined constants. # = 0,1,2,...
trac_normal.ic.psread.eps Diffuseness of the sphere boundary
trac_normal.ic.psread.filename Location of .xyzr file file path
trac_normal.ic.psread.verbose Verbosity (used in parser only)
trac_normal.ic.psread.mult Coordinate multiplier
trac_normal.ic.psread.invert Coordinate multiplier
trac_normal.ic.psread.x0 Coordinate offset


Integrator::Mechanics<Model::Solid::Finite::PseudoLinear::Cubic>

Input name Description Value
type Type of mecahnics to use. Static: do full implicit solve. Dynamic: evolve dynamic equations with explicit dynamics Disable: do nothing. disable static dynamic
time_evolving Treat mechanics fields as changing in time. [false] You should use this if you care about other physics driven by the output of this integrator. false
plot_disp Include displacement field in output true
plot_rhs Include right-hand side in output true
plot_psi Include \(\psi\) field in output true
plot_stress Include stress in output true
plot_strain Include strain in output true
viscous.mu_dashpot Dashpot damping (damps velocity) 0.0
viscous.mu_newton Newtonian viscous damping (damps velocity gradient) 0.0
velocity.ic.type Initializer for RHS none expression
bc.type Select the mechanical boundary conditions

bc.constant.type.xloylozlo 3D Corner
bc.constant.type.xloylozhi 3D Corner
bc.constant.type.xloyhizlo 3D Corner
bc.constant.type.xloyhizhi 3D Corner
bc.constant.type.xhiylozlo 3D Corner
bc.constant.type.xhiylozhi 3D Corner
bc.constant.type.xhiyhizlo 3D Corner
bc.constant.type.xhiyhizhi 3D Corner
bc.constant.type.ylozlo 3D Edge
bc.constant.type.ylozhi 3D Edge
bc.constant.type.yhizlo 3D Edge
bc.constant.type.yhizhi 3D Edge
bc.constant.type.zloxlo 3D Edge
bc.constant.type.zloxhi 3D Edge
bc.constant.type.zhixlo 3D Edge
bc.constant.type.zhixhi 3D Edge
bc.constant.type.xloylo 3D Edge / 2D Corner
bc.constant.type.xloyhi 3D Edge / 2D Corner
bc.constant.type.xhiylo 3D Edge / 2D Corner
bc.constant.type.xhiyhi 3D Edge / 2D Corner
bc.constant.type.xlo 3D Face / 2D Edge
bc.constant.type.xhi 3D Face / 2D Edge
bc.constant.type.ylo 3D Face / 2D Edge
bc.constant.type.yhi 3D Face / 2D Edge
bc.constant.type.zlo 3D Face
bc.constant.type.zhi 3D Face
bc.constant.val.xloylozlo 3D Corner
bc.constant.val.xloylozhi 3D Corner
bc.constant.val.xloyhizlo 3D Corner
bc.constant.val.xloyhizhi 3D Corner
bc.constant.val.xhiylozlo 3D Corner
bc.constant.val.xhiylozhi 3D Corner
bc.constant.val.xhiyhizlo 3D Corner
bc.constant.val.xhiyhizhi 3D Corner
bc.constant.val.ylozlo 3D Edge
bc.constant.val.ylozhi 3D Edge
bc.constant.val.yhizlo 3D Edge
bc.constant.val.yhizhi 3D Edge
bc.constant.val.zloxlo 3D Edge
bc.constant.val.zloxhi 3D Edge
bc.constant.val.zhixlo 3D Edge
bc.constant.val.zhixhi 3D Edge
bc.constant.val.xloylo 3D Edge / 2D Corner
bc.constant.val.xloyhi 3D Edge / 2D Corner
bc.constant.val.xhiylo 3D Edge / 2D Corner
bc.constant.val.xhiyhi 3D Edge / 2D Corner
bc.constant.val.xlo 3D Face / 2D Edge
bc.constant.val.xhi 3D Face / 2D Edge
bc.constant.val.ylo 3D Face / 2D Edge
bc.constant.val.yhi 3D Face / 2D Edge
bc.constant.val.zlo 3D Face
bc.constant.val.zhi 3D Face
bc.tensiontest.type Tension test type. uniaxial_stress_clamp uniaxial_kolsky uniaxial_stress uniaxial_strain
bc.tensiontest.disp Applied displacement (can be interpolator)
bc.tensiontest.trac Applied traction (can be interpolator)
print_model Print out model variables (if enabled by model) false
rhs.type initial condition for right hand side (body force)

rhs.constant.value Array of constant values. The number of values should equal either 1 or N where N is the number of fab components required
rhs.expression.coord coordinate system to use cartesian polar
rhs.expression.region# Mathematical expression in terms of x,y,z,t (if coord=cartesian) or r,theta,z,t (if coord=polar) and any defined constants. # = 0,1,2,...
rhs.trig.nr Number of real (cosin) waves
rhs.trig.ni Number of imaginary (sin) waves
rhs.trig.dim Spatial dimension
rhs.trig.alpha Multiplier
interval Timestep interval for elastic solves (default - solve every time) 0
max_coarsening_level Maximum multigrid coarsening level (default - none, maximum coarsening) -1
print_residual Whether to include residual output field false
elastic_ref_threshold Whether to refine based on elastic solution 0.01
zero_out_displacement Set this to true to zero out the displacement before each solve. (This is a temporary fix - we need to figure out why this is needed.) false
tstart Time to start doing the elastic solve (by default, start immediately) -1.0
nmodels Number of elastic model varieties 1
model#.C11 Elastic constant 1.68
model#.C12 Elastic constant 1.21
model#.C44 Elastic constant 0.75
model#.phi1 Bunge Euler angle \(\phi_1\) 0.0
model#.Phi Bunge Euler angle \(\Phi\) 0.0
model#.phi2 Bunge Euler angle \(\phi_2\) 0.0
eta_ref_threshold Refinement threshold for eta field 0.01
ref_threshold Refinement threshold for strain gradient 0.01
model_neumann_boundary Explicity impose neumann condition on model at domain boundaries (2d only) false
ic.type Select the initial condition for eta

ic.constant.value Array of constant values. The number of values should equal either 1 or N where N is the number of fab components required
ic.ellipse.x0 Coorinates of ellipse center
ic.ellipse.eps Diffuse boundary thickness 0.0
ic.ellipse.A DxD square matrix defining an ellipse.
ic.ellipse.a If A is not defined, then assume a sphere with radius a
ic.ellipse.number_of_inclusions Number of ellipses
ic.ellipse.center center of the ellipse
ic.ellipse.x0 center of the ellipse
ic.ellipse.A either a vector containing ellipse radii, or a matrix defining the ellipse
ic.ellipse.A Same
ic.ellipse.radius Array of radii [depricated]
ic.ellipse.eps Regularization for smooth boundary
ic.ellipse.invert Flip the inside and the outside
ic.voronoi.number_of_grains Number of grains
ic.voronoi.alpha Value to take in the region [1.0]
ic.voronoi.seed Random seed to use
ic.bmp.filename BMP filename. file path
ic.bmp.fit How to position image in space stretch fitheight fitwidth coord
ic.bmp.coord.lo Location of lower-left corner in the domain
ic.bmp.coord.hi Location of upper-right corner in the domain
ic.bmp.channel Color channel to use r g b R G B
ic.bmp.min Scaling value - minimum 0.0
ic.bmp.max Scaling value - maximum 255.0
ic.png.channel Color channel to use (options: r, R, g, G, b, B, a, A) r g b a R G B A
ic.png.filename BMP filename. file path
ic.png.fit how to position the image stretch fitheight fitwidth coord
ic.png.coord.lo Lower-left coordinates of image in domain
ic.png.coord.hi Upper-right coordinates of image in domain
ic.png.min Desired minimum value to scale pixels by 0.0
ic.png.max Desired maximum value to scale pixels by 255.0
ic.expression.coord coordinate system to use cartesian polar
ic.expression.region# Mathematical expression in terms of x,y,z,t (if coord=cartesian) or r,theta,z,t (if coord=polar) and any defined constants. # = 0,1,2,...
ic.psread.eps Diffuseness of the sphere boundary
ic.psread.filename Location of .xyzr file file path
ic.psread.verbose Verbosity (used in parser only)
ic.psread.mult Coordinate multiplier
ic.psread.invert Coordinate multiplier
ic.psread.x0 Coordinate offset
eta.reset_on_regrid Whether to re-initialize eta when re-gridding occurs. Default is false unless eta ic is set, then default is. true. true
psi.ic.type Select initial condition for psi field

psi.ic.ellipse.x0 Coorinates of ellipse center
psi.ic.ellipse.eps Diffuse boundary thickness 0.0
psi.ic.ellipse.A DxD square matrix defining an ellipse.
psi.ic.ellipse.a If A is not defined, then assume a sphere with radius a
psi.ic.ellipse.number_of_inclusions Number of ellipses
psi.ic.ellipse.center center of the ellipse
psi.ic.ellipse.x0 center of the ellipse
psi.ic.ellipse.A either a vector containing ellipse radii, or a matrix defining the ellipse
psi.ic.ellipse.A Same
psi.ic.ellipse.radius Array of radii [depricated]
psi.ic.ellipse.eps Regularization for smooth boundary
psi.ic.ellipse.invert Flip the inside and the outside
psi.ic.constant.value Array of constant values. The number of values should equal either 1 or N where N is the number of fab components required
psi.ic.expression.coord coordinate system to use cartesian polar
psi.ic.expression.region# Mathematical expression in terms of x,y,z,t (if coord=cartesian) or r,theta,z,t (if coord=polar) and any defined constants. # = 0,1,2,...
psi.ic.psread.eps Diffuseness of the sphere boundary
psi.ic.psread.filename Location of .xyzr file file path
psi.ic.psread.verbose Verbosity (used in parser only)
psi.ic.psread.mult Coordinate multiplier
psi.ic.psread.invert Coordinate multiplier
psi.ic.psread.x0 Coordinate offset
psi.ic.png.channel Color channel to use (options: r, R, g, G, b, B, a, A) r g b a R G B A
psi.ic.png.filename BMP filename. file path
psi.ic.png.fit how to position the image stretch fitheight fitwidth coord
psi.ic.png.coord.lo Lower-left coordinates of image in domain
psi.ic.png.coord.hi Upper-right coordinates of image in domain
psi.ic.png.min Desired minimum value to scale pixels by 0.0
psi.ic.png.max Desired maximum value to scale pixels by 255.0
psi.reset_on_regrid Whether to re-initialize psi when re-gridding occurs. Default is false unless a psi ic is set, then default is true. true
trac_normal.ic.type Read in IC for the "normal traction" field (applied at diffuse boundaries)

trac_normal.ic.ellipse.x0 Coorinates of ellipse center
trac_normal.ic.ellipse.eps Diffuse boundary thickness 0.0
trac_normal.ic.ellipse.A DxD square matrix defining an ellipse.
trac_normal.ic.ellipse.a If A is not defined, then assume a sphere with radius a
trac_normal.ic.ellipse.number_of_inclusions Number of ellipses
trac_normal.ic.ellipse.center center of the ellipse
trac_normal.ic.ellipse.x0 center of the ellipse
trac_normal.ic.ellipse.A either a vector containing ellipse radii, or a matrix defining the ellipse
trac_normal.ic.ellipse.A Same
trac_normal.ic.ellipse.radius Array of radii [depricated]
trac_normal.ic.ellipse.eps Regularization for smooth boundary
trac_normal.ic.ellipse.invert Flip the inside and the outside
trac_normal.ic.constant.value Array of constant values. The number of values should equal either 1 or N where N is the number of fab components required
trac_normal.ic.expression.coord coordinate system to use cartesian polar
trac_normal.ic.expression.region# Mathematical expression in terms of x,y,z,t (if coord=cartesian) or r,theta,z,t (if coord=polar) and any defined constants. # = 0,1,2,...
trac_normal.ic.psread.eps Diffuseness of the sphere boundary
trac_normal.ic.psread.filename Location of .xyzr file file path
trac_normal.ic.psread.verbose Verbosity (used in parser only)
trac_normal.ic.psread.mult Coordinate multiplier
trac_normal.ic.psread.invert Coordinate multiplier
trac_normal.ic.psread.x0 Coordinate offset


Integrator::Mechanics<Model::Solid::Finite::PseudoAffine::Cubic>

Input name Description Value
type Type of mecahnics to use. Static: do full implicit solve. Dynamic: evolve dynamic equations with explicit dynamics Disable: do nothing. disable static dynamic
time_evolving Treat mechanics fields as changing in time. [false] You should use this if you care about other physics driven by the output of this integrator. false
plot_disp Include displacement field in output true
plot_rhs Include right-hand side in output true
plot_psi Include \(\psi\) field in output true
plot_stress Include stress in output true
plot_strain Include strain in output true
viscous.mu_dashpot Dashpot damping (damps velocity) 0.0
viscous.mu_newton Newtonian viscous damping (damps velocity gradient) 0.0
velocity.ic.type Initializer for RHS none expression
bc.type Select the mechanical boundary conditions

bc.constant.type.xloylozlo 3D Corner
bc.constant.type.xloylozhi 3D Corner
bc.constant.type.xloyhizlo 3D Corner
bc.constant.type.xloyhizhi 3D Corner
bc.constant.type.xhiylozlo 3D Corner
bc.constant.type.xhiylozhi 3D Corner
bc.constant.type.xhiyhizlo 3D Corner
bc.constant.type.xhiyhizhi 3D Corner
bc.constant.type.ylozlo 3D Edge
bc.constant.type.ylozhi 3D Edge
bc.constant.type.yhizlo 3D Edge
bc.constant.type.yhizhi 3D Edge
bc.constant.type.zloxlo 3D Edge
bc.constant.type.zloxhi 3D Edge
bc.constant.type.zhixlo 3D Edge
bc.constant.type.zhixhi 3D Edge
bc.constant.type.xloylo 3D Edge / 2D Corner
bc.constant.type.xloyhi 3D Edge / 2D Corner
bc.constant.type.xhiylo 3D Edge / 2D Corner
bc.constant.type.xhiyhi 3D Edge / 2D Corner
bc.constant.type.xlo 3D Face / 2D Edge
bc.constant.type.xhi 3D Face / 2D Edge
bc.constant.type.ylo 3D Face / 2D Edge
bc.constant.type.yhi 3D Face / 2D Edge
bc.constant.type.zlo 3D Face
bc.constant.type.zhi 3D Face
bc.constant.val.xloylozlo 3D Corner
bc.constant.val.xloylozhi 3D Corner
bc.constant.val.xloyhizlo 3D Corner
bc.constant.val.xloyhizhi 3D Corner
bc.constant.val.xhiylozlo 3D Corner
bc.constant.val.xhiylozhi 3D Corner
bc.constant.val.xhiyhizlo 3D Corner
bc.constant.val.xhiyhizhi 3D Corner
bc.constant.val.ylozlo 3D Edge
bc.constant.val.ylozhi 3D Edge
bc.constant.val.yhizlo 3D Edge
bc.constant.val.yhizhi 3D Edge
bc.constant.val.zloxlo 3D Edge
bc.constant.val.zloxhi 3D Edge
bc.constant.val.zhixlo 3D Edge
bc.constant.val.zhixhi 3D Edge
bc.constant.val.xloylo 3D Edge / 2D Corner
bc.constant.val.xloyhi 3D Edge / 2D Corner
bc.constant.val.xhiylo 3D Edge / 2D Corner
bc.constant.val.xhiyhi 3D Edge / 2D Corner
bc.constant.val.xlo 3D Face / 2D Edge
bc.constant.val.xhi 3D Face / 2D Edge
bc.constant.val.ylo 3D Face / 2D Edge
bc.constant.val.yhi 3D Face / 2D Edge
bc.constant.val.zlo 3D Face
bc.constant.val.zhi 3D Face
bc.tensiontest.type Tension test type. uniaxial_stress_clamp uniaxial_kolsky uniaxial_stress uniaxial_strain
bc.tensiontest.disp Applied displacement (can be interpolator)
bc.tensiontest.trac Applied traction (can be interpolator)
print_model Print out model variables (if enabled by model) false
rhs.type initial condition for right hand side (body force)

rhs.constant.value Array of constant values. The number of values should equal either 1 or N where N is the number of fab components required
rhs.expression.coord coordinate system to use cartesian polar
rhs.expression.region# Mathematical expression in terms of x,y,z,t (if coord=cartesian) or r,theta,z,t (if coord=polar) and any defined constants. # = 0,1,2,...
rhs.trig.nr Number of real (cosin) waves
rhs.trig.ni Number of imaginary (sin) waves
rhs.trig.dim Spatial dimension
rhs.trig.alpha Multiplier
interval Timestep interval for elastic solves (default - solve every time) 0
max_coarsening_level Maximum multigrid coarsening level (default - none, maximum coarsening) -1
print_residual Whether to include residual output field false
elastic_ref_threshold Whether to refine based on elastic solution 0.01
zero_out_displacement Set this to true to zero out the displacement before each solve. (This is a temporary fix - we need to figure out why this is needed.) false
tstart Time to start doing the elastic solve (by default, start immediately) -1.0
nmodels Number of elastic model varieties 1
model#.F0 Large-strain eigendeformation (Identity = no deformation)
model#.eps0 Small-strain eigendeformation (Zero = no deformation)
eta_ref_threshold Refinement threshold for eta field 0.01
ref_threshold Refinement threshold for strain gradient 0.01
model_neumann_boundary Explicity impose neumann condition on model at domain boundaries (2d only) false
ic.type Select the initial condition for eta

ic.constant.value Array of constant values. The number of values should equal either 1 or N where N is the number of fab components required
ic.ellipse.x0 Coorinates of ellipse center
ic.ellipse.eps Diffuse boundary thickness 0.0
ic.ellipse.A DxD square matrix defining an ellipse.
ic.ellipse.a If A is not defined, then assume a sphere with radius a
ic.ellipse.number_of_inclusions Number of ellipses
ic.ellipse.center center of the ellipse
ic.ellipse.x0 center of the ellipse
ic.ellipse.A either a vector containing ellipse radii, or a matrix defining the ellipse
ic.ellipse.A Same
ic.ellipse.radius Array of radii [depricated]
ic.ellipse.eps Regularization for smooth boundary
ic.ellipse.invert Flip the inside and the outside
ic.voronoi.number_of_grains Number of grains
ic.voronoi.alpha Value to take in the region [1.0]
ic.voronoi.seed Random seed to use
ic.bmp.filename BMP filename. file path
ic.bmp.fit How to position image in space stretch fitheight fitwidth coord
ic.bmp.coord.lo Location of lower-left corner in the domain
ic.bmp.coord.hi Location of upper-right corner in the domain
ic.bmp.channel Color channel to use r g b R G B
ic.bmp.min Scaling value - minimum 0.0
ic.bmp.max Scaling value - maximum 255.0
ic.png.channel Color channel to use (options: r, R, g, G, b, B, a, A) r g b a R G B A
ic.png.filename BMP filename. file path
ic.png.fit how to position the image stretch fitheight fitwidth coord
ic.png.coord.lo Lower-left coordinates of image in domain
ic.png.coord.hi Upper-right coordinates of image in domain
ic.png.min Desired minimum value to scale pixels by 0.0
ic.png.max Desired maximum value to scale pixels by 255.0
ic.expression.coord coordinate system to use cartesian polar
ic.expression.region# Mathematical expression in terms of x,y,z,t (if coord=cartesian) or r,theta,z,t (if coord=polar) and any defined constants. # = 0,1,2,...
ic.psread.eps Diffuseness of the sphere boundary
ic.psread.filename Location of .xyzr file file path
ic.psread.verbose Verbosity (used in parser only)
ic.psread.mult Coordinate multiplier
ic.psread.invert Coordinate multiplier
ic.psread.x0 Coordinate offset
eta.reset_on_regrid Whether to re-initialize eta when re-gridding occurs. Default is false unless eta ic is set, then default is. true. true
psi.ic.type Select initial condition for psi field

psi.ic.ellipse.x0 Coorinates of ellipse center
psi.ic.ellipse.eps Diffuse boundary thickness 0.0
psi.ic.ellipse.A DxD square matrix defining an ellipse.
psi.ic.ellipse.a If A is not defined, then assume a sphere with radius a
psi.ic.ellipse.number_of_inclusions Number of ellipses
psi.ic.ellipse.center center of the ellipse
psi.ic.ellipse.x0 center of the ellipse
psi.ic.ellipse.A either a vector containing ellipse radii, or a matrix defining the ellipse
psi.ic.ellipse.A Same
psi.ic.ellipse.radius Array of radii [depricated]
psi.ic.ellipse.eps Regularization for smooth boundary
psi.ic.ellipse.invert Flip the inside and the outside
psi.ic.constant.value Array of constant values. The number of values should equal either 1 or N where N is the number of fab components required
psi.ic.expression.coord coordinate system to use cartesian polar
psi.ic.expression.region# Mathematical expression in terms of x,y,z,t (if coord=cartesian) or r,theta,z,t (if coord=polar) and any defined constants. # = 0,1,2,...
psi.ic.psread.eps Diffuseness of the sphere boundary
psi.ic.psread.filename Location of .xyzr file file path
psi.ic.psread.verbose Verbosity (used in parser only)
psi.ic.psread.mult Coordinate multiplier
psi.ic.psread.invert Coordinate multiplier
psi.ic.psread.x0 Coordinate offset
psi.ic.png.channel Color channel to use (options: r, R, g, G, b, B, a, A) r g b a R G B A
psi.ic.png.filename BMP filename. file path
psi.ic.png.fit how to position the image stretch fitheight fitwidth coord
psi.ic.png.coord.lo Lower-left coordinates of image in domain
psi.ic.png.coord.hi Upper-right coordinates of image in domain
psi.ic.png.min Desired minimum value to scale pixels by 0.0
psi.ic.png.max Desired maximum value to scale pixels by 255.0
psi.reset_on_regrid Whether to re-initialize psi when re-gridding occurs. Default is false unless a psi ic is set, then default is true. true
trac_normal.ic.type Read in IC for the "normal traction" field (applied at diffuse boundaries)

trac_normal.ic.ellipse.x0 Coorinates of ellipse center
trac_normal.ic.ellipse.eps Diffuse boundary thickness 0.0
trac_normal.ic.ellipse.A DxD square matrix defining an ellipse.
trac_normal.ic.ellipse.a If A is not defined, then assume a sphere with radius a
trac_normal.ic.ellipse.number_of_inclusions Number of ellipses
trac_normal.ic.ellipse.center center of the ellipse
trac_normal.ic.ellipse.x0 center of the ellipse
trac_normal.ic.ellipse.A either a vector containing ellipse radii, or a matrix defining the ellipse
trac_normal.ic.ellipse.A Same
trac_normal.ic.ellipse.radius Array of radii [depricated]
trac_normal.ic.ellipse.eps Regularization for smooth boundary
trac_normal.ic.ellipse.invert Flip the inside and the outside
trac_normal.ic.constant.value Array of constant values. The number of values should equal either 1 or N where N is the number of fab components required
trac_normal.ic.expression.coord coordinate system to use cartesian polar
trac_normal.ic.expression.region# Mathematical expression in terms of x,y,z,t (if coord=cartesian) or r,theta,z,t (if coord=polar) and any defined constants. # = 0,1,2,...
trac_normal.ic.psread.eps Diffuseness of the sphere boundary
trac_normal.ic.psread.filename Location of .xyzr file file path
trac_normal.ic.psread.verbose Verbosity (used in parser only)
trac_normal.ic.psread.mult Coordinate multiplier
trac_normal.ic.psread.invert Coordinate multiplier
trac_normal.ic.psread.x0 Coordinate offset


Integrator::Mechanics<Model::Solid::Affine::J2>

Input name Description Value
type Type of mecahnics to use. Static: do full implicit solve. Dynamic: evolve dynamic equations with explicit dynamics Disable: do nothing. disable static dynamic
time_evolving Treat mechanics fields as changing in time. [false] You should use this if you care about other physics driven by the output of this integrator. false
plot_disp Include displacement field in output true
plot_rhs Include right-hand side in output true
plot_psi Include \(\psi\) field in output true
plot_stress Include stress in output true
plot_strain Include strain in output true
viscous.mu_dashpot Dashpot damping (damps velocity) 0.0
viscous.mu_newton Newtonian viscous damping (damps velocity gradient) 0.0
velocity.ic.type Initializer for RHS none expression
bc.type Select the mechanical boundary conditions

bc.constant.type.xloylozlo 3D Corner
bc.constant.type.xloylozhi 3D Corner
bc.constant.type.xloyhizlo 3D Corner
bc.constant.type.xloyhizhi 3D Corner
bc.constant.type.xhiylozlo 3D Corner
bc.constant.type.xhiylozhi 3D Corner
bc.constant.type.xhiyhizlo 3D Corner
bc.constant.type.xhiyhizhi 3D Corner
bc.constant.type.ylozlo 3D Edge
bc.constant.type.ylozhi 3D Edge
bc.constant.type.yhizlo 3D Edge
bc.constant.type.yhizhi 3D Edge
bc.constant.type.zloxlo 3D Edge
bc.constant.type.zloxhi 3D Edge
bc.constant.type.zhixlo 3D Edge
bc.constant.type.zhixhi 3D Edge
bc.constant.type.xloylo 3D Edge / 2D Corner
bc.constant.type.xloyhi 3D Edge / 2D Corner
bc.constant.type.xhiylo 3D Edge / 2D Corner
bc.constant.type.xhiyhi 3D Edge / 2D Corner
bc.constant.type.xlo 3D Face / 2D Edge
bc.constant.type.xhi 3D Face / 2D Edge
bc.constant.type.ylo 3D Face / 2D Edge
bc.constant.type.yhi 3D Face / 2D Edge
bc.constant.type.zlo 3D Face
bc.constant.type.zhi 3D Face
bc.constant.val.xloylozlo 3D Corner
bc.constant.val.xloylozhi 3D Corner
bc.constant.val.xloyhizlo 3D Corner
bc.constant.val.xloyhizhi 3D Corner
bc.constant.val.xhiylozlo 3D Corner
bc.constant.val.xhiylozhi 3D Corner
bc.constant.val.xhiyhizlo 3D Corner
bc.constant.val.xhiyhizhi 3D Corner
bc.constant.val.ylozlo 3D Edge
bc.constant.val.ylozhi 3D Edge
bc.constant.val.yhizlo 3D Edge
bc.constant.val.yhizhi 3D Edge
bc.constant.val.zloxlo 3D Edge
bc.constant.val.zloxhi 3D Edge
bc.constant.val.zhixlo 3D Edge
bc.constant.val.zhixhi 3D Edge
bc.constant.val.xloylo 3D Edge / 2D Corner
bc.constant.val.xloyhi 3D Edge / 2D Corner
bc.constant.val.xhiylo 3D Edge / 2D Corner
bc.constant.val.xhiyhi 3D Edge / 2D Corner
bc.constant.val.xlo 3D Face / 2D Edge
bc.constant.val.xhi 3D Face / 2D Edge
bc.constant.val.ylo 3D Face / 2D Edge
bc.constant.val.yhi 3D Face / 2D Edge
bc.constant.val.zlo 3D Face
bc.constant.val.zhi 3D Face
bc.tensiontest.type Tension test type. uniaxial_stress_clamp uniaxial_kolsky uniaxial_stress uniaxial_strain
bc.tensiontest.disp Applied displacement (can be interpolator)
bc.tensiontest.trac Applied traction (can be interpolator)
print_model Print out model variables (if enabled by model) false
rhs.type initial condition for right hand side (body force)

rhs.constant.value Array of constant values. The number of values should equal either 1 or N where N is the number of fab components required
rhs.expression.coord coordinate system to use cartesian polar
rhs.expression.region# Mathematical expression in terms of x,y,z,t (if coord=cartesian) or r,theta,z,t (if coord=polar) and any defined constants. # = 0,1,2,...
rhs.trig.nr Number of real (cosin) waves
rhs.trig.ni Number of imaginary (sin) waves
rhs.trig.dim Spatial dimension
rhs.trig.alpha Multiplier
interval Timestep interval for elastic solves (default - solve every time) 0
max_coarsening_level Maximum multigrid coarsening level (default - none, maximum coarsening) -1
print_residual Whether to include residual output field false
elastic_ref_threshold Whether to refine based on elastic solution 0.01
zero_out_displacement Set this to true to zero out the displacement before each solve. (This is a temporary fix - we need to figure out why this is needed.) false
tstart Time to start doing the elastic solve (by default, start immediately) -1.0
nmodels Number of elastic model varieties 1
model#.sigma0 J2 Yield criterion 1.0
model#.hardening Hardening coefficient (negative value disables rate hardening) -1.0
model#.ratecoeff Rate coefficient (negative value disables rate hardening) -1.0
eta_ref_threshold Refinement threshold for eta field 0.01
ref_threshold Refinement threshold for strain gradient 0.01
model_neumann_boundary Explicity impose neumann condition on model at domain boundaries (2d only) false
ic.type Select the initial condition for eta

ic.constant.value Array of constant values. The number of values should equal either 1 or N where N is the number of fab components required
ic.ellipse.x0 Coorinates of ellipse center
ic.ellipse.eps Diffuse boundary thickness 0.0
ic.ellipse.A DxD square matrix defining an ellipse.
ic.ellipse.a If A is not defined, then assume a sphere with radius a
ic.ellipse.number_of_inclusions Number of ellipses
ic.ellipse.center center of the ellipse
ic.ellipse.x0 center of the ellipse
ic.ellipse.A either a vector containing ellipse radii, or a matrix defining the ellipse
ic.ellipse.A Same
ic.ellipse.radius Array of radii [depricated]
ic.ellipse.eps Regularization for smooth boundary
ic.ellipse.invert Flip the inside and the outside
ic.voronoi.number_of_grains Number of grains
ic.voronoi.alpha Value to take in the region [1.0]
ic.voronoi.seed Random seed to use
ic.bmp.filename BMP filename. file path
ic.bmp.fit How to position image in space stretch fitheight fitwidth coord
ic.bmp.coord.lo Location of lower-left corner in the domain
ic.bmp.coord.hi Location of upper-right corner in the domain
ic.bmp.channel Color channel to use r g b R G B
ic.bmp.min Scaling value - minimum 0.0
ic.bmp.max Scaling value - maximum 255.0
ic.png.channel Color channel to use (options: r, R, g, G, b, B, a, A) r g b a R G B A
ic.png.filename BMP filename. file path
ic.png.fit how to position the image stretch fitheight fitwidth coord
ic.png.coord.lo Lower-left coordinates of image in domain
ic.png.coord.hi Upper-right coordinates of image in domain
ic.png.min Desired minimum value to scale pixels by 0.0
ic.png.max Desired maximum value to scale pixels by 255.0
ic.expression.coord coordinate system to use cartesian polar
ic.expression.region# Mathematical expression in terms of x,y,z,t (if coord=cartesian) or r,theta,z,t (if coord=polar) and any defined constants. # = 0,1,2,...
ic.psread.eps Diffuseness of the sphere boundary
ic.psread.filename Location of .xyzr file file path
ic.psread.verbose Verbosity (used in parser only)
ic.psread.mult Coordinate multiplier
ic.psread.invert Coordinate multiplier
ic.psread.x0 Coordinate offset
eta.reset_on_regrid Whether to re-initialize eta when re-gridding occurs. Default is false unless eta ic is set, then default is. true. true
psi.ic.type Select initial condition for psi field

psi.ic.ellipse.x0 Coorinates of ellipse center
psi.ic.ellipse.eps Diffuse boundary thickness 0.0
psi.ic.ellipse.A DxD square matrix defining an ellipse.
psi.ic.ellipse.a If A is not defined, then assume a sphere with radius a
psi.ic.ellipse.number_of_inclusions Number of ellipses
psi.ic.ellipse.center center of the ellipse
psi.ic.ellipse.x0 center of the ellipse
psi.ic.ellipse.A either a vector containing ellipse radii, or a matrix defining the ellipse
psi.ic.ellipse.A Same
psi.ic.ellipse.radius Array of radii [depricated]
psi.ic.ellipse.eps Regularization for smooth boundary
psi.ic.ellipse.invert Flip the inside and the outside
psi.ic.constant.value Array of constant values. The number of values should equal either 1 or N where N is the number of fab components required
psi.ic.expression.coord coordinate system to use cartesian polar
psi.ic.expression.region# Mathematical expression in terms of x,y,z,t (if coord=cartesian) or r,theta,z,t (if coord=polar) and any defined constants. # = 0,1,2,...
psi.ic.psread.eps Diffuseness of the sphere boundary
psi.ic.psread.filename Location of .xyzr file file path
psi.ic.psread.verbose Verbosity (used in parser only)
psi.ic.psread.mult Coordinate multiplier
psi.ic.psread.invert Coordinate multiplier
psi.ic.psread.x0 Coordinate offset
psi.ic.png.channel Color channel to use (options: r, R, g, G, b, B, a, A) r g b a R G B A
psi.ic.png.filename BMP filename. file path
psi.ic.png.fit how to position the image stretch fitheight fitwidth coord
psi.ic.png.coord.lo Lower-left coordinates of image in domain
psi.ic.png.coord.hi Upper-right coordinates of image in domain
psi.ic.png.min Desired minimum value to scale pixels by 0.0
psi.ic.png.max Desired maximum value to scale pixels by 255.0
psi.reset_on_regrid Whether to re-initialize psi when re-gridding occurs. Default is false unless a psi ic is set, then default is true. true
trac_normal.ic.type Read in IC for the "normal traction" field (applied at diffuse boundaries)

trac_normal.ic.ellipse.x0 Coorinates of ellipse center
trac_normal.ic.ellipse.eps Diffuse boundary thickness 0.0
trac_normal.ic.ellipse.A DxD square matrix defining an ellipse.
trac_normal.ic.ellipse.a If A is not defined, then assume a sphere with radius a
trac_normal.ic.ellipse.number_of_inclusions Number of ellipses
trac_normal.ic.ellipse.center center of the ellipse
trac_normal.ic.ellipse.x0 center of the ellipse
trac_normal.ic.ellipse.A either a vector containing ellipse radii, or a matrix defining the ellipse
trac_normal.ic.ellipse.A Same
trac_normal.ic.ellipse.radius Array of radii [depricated]
trac_normal.ic.ellipse.eps Regularization for smooth boundary
trac_normal.ic.ellipse.invert Flip the inside and the outside
trac_normal.ic.constant.value Array of constant values. The number of values should equal either 1 or N where N is the number of fab components required
trac_normal.ic.expression.coord coordinate system to use cartesian polar
trac_normal.ic.expression.region# Mathematical expression in terms of x,y,z,t (if coord=cartesian) or r,theta,z,t (if coord=polar) and any defined constants. # = 0,1,2,...
trac_normal.ic.psread.eps Diffuseness of the sphere boundary
trac_normal.ic.psread.filename Location of .xyzr file file path
trac_normal.ic.psread.verbose Verbosity (used in parser only)
trac_normal.ic.psread.mult Coordinate multiplier
trac_normal.ic.psread.invert Coordinate multiplier
trac_normal.ic.psread.x0 Coordinate offset


Integrator::Mechanics<Model::Solid::Finite::CrystalPlastic>

Input name Description Value
type Type of mecahnics to use. Static: do full implicit solve. Dynamic: evolve dynamic equations with explicit dynamics Disable: do nothing. disable static dynamic
time_evolving Treat mechanics fields as changing in time. [false] You should use this if you care about other physics driven by the output of this integrator. false
plot_disp Include displacement field in output true
plot_rhs Include right-hand side in output true
plot_psi Include \(\psi\) field in output true
plot_stress Include stress in output true
plot_strain Include strain in output true
viscous.mu_dashpot Dashpot damping (damps velocity) 0.0
viscous.mu_newton Newtonian viscous damping (damps velocity gradient) 0.0
velocity.ic.type Initializer for RHS none expression
bc.type Select the mechanical boundary conditions

bc.constant.type.xloylozlo 3D Corner
bc.constant.type.xloylozhi 3D Corner
bc.constant.type.xloyhizlo 3D Corner
bc.constant.type.xloyhizhi 3D Corner
bc.constant.type.xhiylozlo 3D Corner
bc.constant.type.xhiylozhi 3D Corner
bc.constant.type.xhiyhizlo 3D Corner
bc.constant.type.xhiyhizhi 3D Corner
bc.constant.type.ylozlo 3D Edge
bc.constant.type.ylozhi 3D Edge
bc.constant.type.yhizlo 3D Edge
bc.constant.type.yhizhi 3D Edge
bc.constant.type.zloxlo 3D Edge
bc.constant.type.zloxhi 3D Edge
bc.constant.type.zhixlo 3D Edge
bc.constant.type.zhixhi 3D Edge
bc.constant.type.xloylo 3D Edge / 2D Corner
bc.constant.type.xloyhi 3D Edge / 2D Corner
bc.constant.type.xhiylo 3D Edge / 2D Corner
bc.constant.type.xhiyhi 3D Edge / 2D Corner
bc.constant.type.xlo 3D Face / 2D Edge
bc.constant.type.xhi 3D Face / 2D Edge
bc.constant.type.ylo 3D Face / 2D Edge
bc.constant.type.yhi 3D Face / 2D Edge
bc.constant.type.zlo 3D Face
bc.constant.type.zhi 3D Face
bc.constant.val.xloylozlo 3D Corner
bc.constant.val.xloylozhi 3D Corner
bc.constant.val.xloyhizlo 3D Corner
bc.constant.val.xloyhizhi 3D Corner
bc.constant.val.xhiylozlo 3D Corner
bc.constant.val.xhiylozhi 3D Corner
bc.constant.val.xhiyhizlo 3D Corner
bc.constant.val.xhiyhizhi 3D Corner
bc.constant.val.ylozlo 3D Edge
bc.constant.val.ylozhi 3D Edge
bc.constant.val.yhizlo 3D Edge
bc.constant.val.yhizhi 3D Edge
bc.constant.val.zloxlo 3D Edge
bc.constant.val.zloxhi 3D Edge
bc.constant.val.zhixlo 3D Edge
bc.constant.val.zhixhi 3D Edge
bc.constant.val.xloylo 3D Edge / 2D Corner
bc.constant.val.xloyhi 3D Edge / 2D Corner
bc.constant.val.xhiylo 3D Edge / 2D Corner
bc.constant.val.xhiyhi 3D Edge / 2D Corner
bc.constant.val.xlo 3D Face / 2D Edge
bc.constant.val.xhi 3D Face / 2D Edge
bc.constant.val.ylo 3D Face / 2D Edge
bc.constant.val.yhi 3D Face / 2D Edge
bc.constant.val.zlo 3D Face
bc.constant.val.zhi 3D Face
bc.tensiontest.type Tension test type. uniaxial_stress_clamp uniaxial_kolsky uniaxial_stress uniaxial_strain
bc.tensiontest.disp Applied displacement (can be interpolator)
bc.tensiontest.trac Applied traction (can be interpolator)
print_model Print out model variables (if enabled by model) false
rhs.type initial condition for right hand side (body force)

rhs.constant.value Array of constant values. The number of values should equal either 1 or N where N is the number of fab components required
rhs.expression.coord coordinate system to use cartesian polar
rhs.expression.region# Mathematical expression in terms of x,y,z,t (if coord=cartesian) or r,theta,z,t (if coord=polar) and any defined constants. # = 0,1,2,...
rhs.trig.nr Number of real (cosin) waves
rhs.trig.ni Number of imaginary (sin) waves
rhs.trig.dim Spatial dimension
rhs.trig.alpha Multiplier
interval Timestep interval for elastic solves (default - solve every time) 0
max_coarsening_level Maximum multigrid coarsening level (default - none, maximum coarsening) -1
print_residual Whether to include residual output field false
elastic_ref_threshold Whether to refine based on elastic solution 0.01
zero_out_displacement Set this to true to zero out the displacement before each solve. (This is a temporary fix - we need to figure out why this is needed.) false
tstart Time to start doing the elastic solve (by default, start immediately) -1.0
nmodels Number of elastic model varieties 1
model#.tau_crss Critical resolved shear stress \(\tau_{crss}\)
model#.gammadot0 Rate hardening coefficient \(\dot{\gamma}_0\) 1.0
model#.m_rate_inv Inverse of the hardening exponent \(\frac{1}{m}\) 0.5
model#.tstart Time to activate plastic slip 0.0
eta_ref_threshold Refinement threshold for eta field 0.01
ref_threshold Refinement threshold for strain gradient 0.01
model_neumann_boundary Explicity impose neumann condition on model at domain boundaries (2d only) false
ic.type Select the initial condition for eta

ic.constant.value Array of constant values. The number of values should equal either 1 or N where N is the number of fab components required
ic.ellipse.x0 Coorinates of ellipse center
ic.ellipse.eps Diffuse boundary thickness 0.0
ic.ellipse.A DxD square matrix defining an ellipse.
ic.ellipse.a If A is not defined, then assume a sphere with radius a
ic.ellipse.number_of_inclusions Number of ellipses
ic.ellipse.center center of the ellipse
ic.ellipse.x0 center of the ellipse
ic.ellipse.A either a vector containing ellipse radii, or a matrix defining the ellipse
ic.ellipse.A Same
ic.ellipse.radius Array of radii [depricated]
ic.ellipse.eps Regularization for smooth boundary
ic.ellipse.invert Flip the inside and the outside
ic.voronoi.number_of_grains Number of grains
ic.voronoi.alpha Value to take in the region [1.0]
ic.voronoi.seed Random seed to use
ic.bmp.filename BMP filename. file path
ic.bmp.fit How to position image in space stretch fitheight fitwidth coord
ic.bmp.coord.lo Location of lower-left corner in the domain
ic.bmp.coord.hi Location of upper-right corner in the domain
ic.bmp.channel Color channel to use r g b R G B
ic.bmp.min Scaling value - minimum 0.0
ic.bmp.max Scaling value - maximum 255.0
ic.png.channel Color channel to use (options: r, R, g, G, b, B, a, A) r g b a R G B A
ic.png.filename BMP filename. file path
ic.png.fit how to position the image stretch fitheight fitwidth coord
ic.png.coord.lo Lower-left coordinates of image in domain
ic.png.coord.hi Upper-right coordinates of image in domain
ic.png.min Desired minimum value to scale pixels by 0.0
ic.png.max Desired maximum value to scale pixels by 255.0
ic.expression.coord coordinate system to use cartesian polar
ic.expression.region# Mathematical expression in terms of x,y,z,t (if coord=cartesian) or r,theta,z,t (if coord=polar) and any defined constants. # = 0,1,2,...
ic.psread.eps Diffuseness of the sphere boundary
ic.psread.filename Location of .xyzr file file path
ic.psread.verbose Verbosity (used in parser only)
ic.psread.mult Coordinate multiplier
ic.psread.invert Coordinate multiplier
ic.psread.x0 Coordinate offset
eta.reset_on_regrid Whether to re-initialize eta when re-gridding occurs. Default is false unless eta ic is set, then default is. true. true
psi.ic.type Select initial condition for psi field

psi.ic.ellipse.x0 Coorinates of ellipse center
psi.ic.ellipse.eps Diffuse boundary thickness 0.0
psi.ic.ellipse.A DxD square matrix defining an ellipse.
psi.ic.ellipse.a If A is not defined, then assume a sphere with radius a
psi.ic.ellipse.number_of_inclusions Number of ellipses
psi.ic.ellipse.center center of the ellipse
psi.ic.ellipse.x0 center of the ellipse
psi.ic.ellipse.A either a vector containing ellipse radii, or a matrix defining the ellipse
psi.ic.ellipse.A Same
psi.ic.ellipse.radius Array of radii [depricated]
psi.ic.ellipse.eps Regularization for smooth boundary
psi.ic.ellipse.invert Flip the inside and the outside
psi.ic.constant.value Array of constant values. The number of values should equal either 1 or N where N is the number of fab components required
psi.ic.expression.coord coordinate system to use cartesian polar
psi.ic.expression.region# Mathematical expression in terms of x,y,z,t (if coord=cartesian) or r,theta,z,t (if coord=polar) and any defined constants. # = 0,1,2,...
psi.ic.psread.eps Diffuseness of the sphere boundary
psi.ic.psread.filename Location of .xyzr file file path
psi.ic.psread.verbose Verbosity (used in parser only)
psi.ic.psread.mult Coordinate multiplier
psi.ic.psread.invert Coordinate multiplier
psi.ic.psread.x0 Coordinate offset
psi.ic.png.channel Color channel to use (options: r, R, g, G, b, B, a, A) r g b a R G B A
psi.ic.png.filename BMP filename. file path
psi.ic.png.fit how to position the image stretch fitheight fitwidth coord
psi.ic.png.coord.lo Lower-left coordinates of image in domain
psi.ic.png.coord.hi Upper-right coordinates of image in domain
psi.ic.png.min Desired minimum value to scale pixels by 0.0
psi.ic.png.max Desired maximum value to scale pixels by 255.0
psi.reset_on_regrid Whether to re-initialize psi when re-gridding occurs. Default is false unless a psi ic is set, then default is true. true
trac_normal.ic.type Read in IC for the "normal traction" field (applied at diffuse boundaries)

trac_normal.ic.ellipse.x0 Coorinates of ellipse center
trac_normal.ic.ellipse.eps Diffuse boundary thickness 0.0
trac_normal.ic.ellipse.A DxD square matrix defining an ellipse.
trac_normal.ic.ellipse.a If A is not defined, then assume a sphere with radius a
trac_normal.ic.ellipse.number_of_inclusions Number of ellipses
trac_normal.ic.ellipse.center center of the ellipse
trac_normal.ic.ellipse.x0 center of the ellipse
trac_normal.ic.ellipse.A either a vector containing ellipse radii, or a matrix defining the ellipse
trac_normal.ic.ellipse.A Same
trac_normal.ic.ellipse.radius Array of radii [depricated]
trac_normal.ic.ellipse.eps Regularization for smooth boundary
trac_normal.ic.ellipse.invert Flip the inside and the outside
trac_normal.ic.constant.value Array of constant values. The number of values should equal either 1 or N where N is the number of fab components required
trac_normal.ic.expression.coord coordinate system to use cartesian polar
trac_normal.ic.expression.region# Mathematical expression in terms of x,y,z,t (if coord=cartesian) or r,theta,z,t (if coord=polar) and any defined constants. # = 0,1,2,...
trac_normal.ic.psread.eps Diffuseness of the sphere boundary
trac_normal.ic.psread.filename Location of .xyzr file file path
trac_normal.ic.psread.verbose Verbosity (used in parser only)
trac_normal.ic.psread.mult Coordinate multiplier
trac_normal.ic.psread.invert Coordinate multiplier
trac_normal.ic.psread.x0 Coordinate offset


\(\quad\)