thermoelastic -------------------------- .. raw:: html
Input name Description Value


Integrator::ThermoElastic

Input name Description Value
hc.heat.alpha Diffusion coefficient \(\alpha\). *This is an example of a required input variable - - program will terminate unless it is provided.* required
hc.heat.refinement_threshold Criterion for mesh refinement. *This is an example of a default input variable. The default value is provided here, not in the definition of the variable.* 0.01
hc.ic.type Initial condition type.

hc.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
hc.ic.sphere.radius Radius of the sphere 1.0
hc.ic.sphere.center Vector location of the sphere center
hc.ic.sphere.inside Value of the field inside the sphere 1.0
hc.ic.sphere.outside Value of the field outside teh sphere 0.0
hc.ic.sphere.type Type - can be cylinder oriented along the x, y, z directions or full sphere. xyz yz zx xy
hc.ic.expression.coord coordinate system to use cartesian polar
hc.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,...
hc.bc.temp.type Select BC object for temperature

hc.bc.temp.constant.type.xlo BC type on the lower x edge (2d) face (3d) dirichlet
hc.bc.temp.constant.type.xhi BC type on the upper x edge (2d) face (3d) dirichlet
hc.bc.temp.constant.type.ylo BC type on the lower y edge (2d) face (3d) dirichlet
hc.bc.temp.constant.type.yhi BC type on the upper y edge (2d) face (3d) dirichlet
hc.bc.temp.constant.type.zlo BC type on the lower z face (processed but ignored in 2d to prevent unused input errors) dirichlet
hc.bc.temp.constant.type.zhi BC type on the upper z face (processed but ignored in 2d to prevent unused input errors) dirichlet
hc.bc.temp.constant.val.xlo BC value on the lower x edge (2d) face (3d) 0.0
hc.bc.temp.constant.val.xhi BC value on the upper x edge (2d) face (3d) 0.0
hc.bc.temp.constant.val.ylo BC value on the lower y edge (2d) face (3d) 0.0
hc.bc.temp.constant.val.yhi BC value on the upper y edge (2d) face (3d) 0.0
hc.bc.temp.constant.val.zlo BC value on the lower z face (processed but ignored in 2d to prevent unused input errors) 0.0
hc.bc.temp.constant.val.zhi BC value on the upper z face (processed but ignored in 2d to prevent unused input errors) 0.0
hc.bc.temp.expression.type.xlo BC type on the lower x edge (2d) face (3d) dirichlet
hc.bc.temp.expression.type.xhi BC type on the upper x edge (2d) face (3d) dirichlet
hc.bc.temp.expression.type.ylo BC type on the lower y edge (2d) face (3d) dirichlet
hc.bc.temp.expression.type.yhi BC type on the upper y edge (2d) face (3d) dirichlet
hc.bc.temp.expression.type.zlo BC type on the lower z face (processed but ignored in 2d to prevent unused input errors) dirichlet
hc.bc.temp.expression.type.zhi BC type on the upper z face (processed but ignored in 2d to prevent unused input errors) dirichlet
hc.method Select between using a realspace solve or the spectral method realspace spectral
el.type Type of mecahnics to use. Static: do full implicit solve. Dynamic: evolve dynamic equations with explicit dynamics Disable: do nothing. disable static dynamic
el.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
el.plot_disp Include displacement field in output true
el.plot_rhs Include right-hand side in output true
el.plot_psi Include \(\psi\) field in output true
el.plot_stress Include stress in output true
el.plot_strain Include strain in output true
el.viscous.mu_dashpot Dashpot damping (damps velocity) 0.0
el.viscous.mu_newton Newtonian viscous damping (damps velocity gradient) 0.0
el.velocity.ic.type Initializer for RHS none expression
el.bc.type Select the mechanical boundary conditions

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

el.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
el.rhs.expression.coord coordinate system to use cartesian polar
el.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,...
el.rhs.trig.nr Number of real (cosin) waves
el.rhs.trig.ni Number of imaginary (sin) waves
el.rhs.trig.dim Spatial dimension
el.rhs.trig.alpha Multiplier
el.interval Timestep interval for elastic solves (default - solve every time) 0
el.max_coarsening_level Maximum multigrid coarsening level (default - none, maximum coarsening) -1
el.print_residual Whether to include residual output field false
el.elastic_ref_threshold Whether to refine based on elastic solution 0.01
el.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
el.tstart Time to start doing the elastic solve (by default, start immediately) -1.0
el.nmodels Number of elastic model varieties 1
el.model#.lambda el.model#.mu el.model#.E el.model#.nu el.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.
el.model#.F0 Eigendeformation gradient
el.eta_ref_threshold Refinement threshold for eta field 0.01
el.ref_threshold Refinement threshold for strain gradient 0.01
el.model_neumann_boundary Explicity impose neumann condition on model at domain boundaries (2d only) false
el.ic.type Select the initial condition for eta

el.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
el.ic.ellipse.x0 Coorinates of ellipse center
el.ic.ellipse.eps Diffuse boundary thickness 0.0
el.ic.ellipse.A DxD square matrix defining an ellipse.
el.ic.ellipse.a If A is not defined, then assume a sphere with radius a
el.ic.ellipse.number_of_inclusions Number of ellipses
el.ic.ellipse.center center of the ellipse
el.ic.ellipse.x0 center of the ellipse
el.ic.ellipse.A either a vector containing ellipse radii, or a matrix defining the ellipse
el.ic.ellipse.A Same
el.ic.ellipse.radius Array of radii [depricated]
el.ic.ellipse.eps Regularization for smooth boundary
el.ic.ellipse.invert Flip the inside and the outside
el.ic.voronoi.number_of_grains Number of grains
el.ic.voronoi.alpha Value to take in the region [1.0]
el.ic.voronoi.seed Random seed to use
el.ic.bmp.filename BMP filename. file path
el.ic.bmp.fit How to position image in space stretch fitheight fitwidth coord
el.ic.bmp.coord.lo Location of lower-left corner in the domain
el.ic.bmp.coord.hi Location of upper-right corner in the domain
el.ic.bmp.channel Color channel to use r g b R G B
el.ic.bmp.min Scaling value - minimum 0.0
el.ic.bmp.max Scaling value - maximum 255.0
el.ic.png.channel Color channel to use (options: r, R, g, G, b, B, a, A) r g b a R G B A
el.ic.png.filename BMP filename. file path
el.ic.png.fit how to position the image stretch fitheight fitwidth coord
el.ic.png.coord.lo Lower-left coordinates of image in domain
el.ic.png.coord.hi Upper-right coordinates of image in domain
el.ic.png.min Desired minimum value to scale pixels by 0.0
el.ic.png.max Desired maximum value to scale pixels by 255.0
el.ic.expression.coord coordinate system to use cartesian polar
el.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,...
el.ic.psread.eps Diffuseness of the sphere boundary
el.ic.psread.filename Location of .xyzr file file path
el.ic.psread.verbose Verbosity (used in parser only)
el.ic.psread.mult Coordinate multiplier
el.ic.psread.invert Coordinate multiplier
el.ic.psread.x0 Coordinate offset
el.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
el.psi.ic.type Select initial condition for psi field

el.psi.ic.ellipse.x0 Coorinates of ellipse center
el.psi.ic.ellipse.eps Diffuse boundary thickness 0.0
el.psi.ic.ellipse.A DxD square matrix defining an ellipse.
el.psi.ic.ellipse.a If A is not defined, then assume a sphere with radius a
el.psi.ic.ellipse.number_of_inclusions Number of ellipses
el.psi.ic.ellipse.center center of the ellipse
el.psi.ic.ellipse.x0 center of the ellipse
el.psi.ic.ellipse.A either a vector containing ellipse radii, or a matrix defining the ellipse
el.psi.ic.ellipse.A Same
el.psi.ic.ellipse.radius Array of radii [depricated]
el.psi.ic.ellipse.eps Regularization for smooth boundary
el.psi.ic.ellipse.invert Flip the inside and the outside
el.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
el.psi.ic.expression.coord coordinate system to use cartesian polar
el.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,...
el.psi.ic.psread.eps Diffuseness of the sphere boundary
el.psi.ic.psread.filename Location of .xyzr file file path
el.psi.ic.psread.verbose Verbosity (used in parser only)
el.psi.ic.psread.mult Coordinate multiplier
el.psi.ic.psread.invert Coordinate multiplier
el.psi.ic.psread.x0 Coordinate offset
el.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
el.psi.ic.png.filename BMP filename. file path
el.psi.ic.png.fit how to position the image stretch fitheight fitwidth coord
el.psi.ic.png.coord.lo Lower-left coordinates of image in domain
el.psi.ic.png.coord.hi Upper-right coordinates of image in domain
el.psi.ic.png.min Desired minimum value to scale pixels by 0.0
el.psi.ic.png.max Desired maximum value to scale pixels by 255.0
el.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
el.trac_normal.ic.type Read in IC for the "normal traction" field (applied at diffuse boundaries)

el.trac_normal.ic.ellipse.x0 Coorinates of ellipse center
el.trac_normal.ic.ellipse.eps Diffuse boundary thickness 0.0
el.trac_normal.ic.ellipse.A DxD square matrix defining an ellipse.
el.trac_normal.ic.ellipse.a If A is not defined, then assume a sphere with radius a
el.trac_normal.ic.ellipse.number_of_inclusions Number of ellipses
el.trac_normal.ic.ellipse.center center of the ellipse
el.trac_normal.ic.ellipse.x0 center of the ellipse
el.trac_normal.ic.ellipse.A either a vector containing ellipse radii, or a matrix defining the ellipse
el.trac_normal.ic.ellipse.A Same
el.trac_normal.ic.ellipse.radius Array of radii [depricated]
el.trac_normal.ic.ellipse.eps Regularization for smooth boundary
el.trac_normal.ic.ellipse.invert Flip the inside and the outside
el.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
el.trac_normal.ic.expression.coord coordinate system to use cartesian polar
el.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,...
el.trac_normal.ic.psread.eps Diffuseness of the sphere boundary
el.trac_normal.ic.psread.filename Location of .xyzr file file path
el.trac_normal.ic.psread.verbose Verbosity (used in parser only)
el.trac_normal.ic.psread.mult Coordinate multiplier
el.trac_normal.ic.psread.invert Coordinate multiplier
el.trac_normal.ic.psread.x0 Coordinate offset
alpha Diffusion coefficient


:math:`\quad`