Input File Structure¶
Below is the documentation for Serac input files, generated automatically by Axom's inlet component.
input_file¶
Field Name |
Description |
Default Value |
Range/Valid Values |
Required |
|---|---|---|---|---|
dt |
Time step. |
0.250000 |
☐ |
|
t_final |
Final time for simulation. |
1.000000 |
☐ |
thermal_solid¶
Description: Thermal solid module
coef_thermal_expansion¶
Description: Coefficient of thermal expansion for isotropic thermal expansion
Field Name |
Description |
Default Value |
Range/Valid Values |
Required |
|---|---|---|---|---|
constant |
The constant scalar value to use as the coefficient |
☐ |
||
component |
The vector component to which the scalar coefficient should be applied |
☐ |
Function Name |
Description |
Signature |
Required |
|---|---|---|---|
scalar_function |
The function to use for an mfem::FunctionCoefficient |
Double(Vector, Double) |
☐ |
vector_function |
The function to use for an mfem::VectorFunctionCoefficient |
Vector(Vector, Double) |
☐ |
vector_constant¶
Description: The constant vector to use as the coefficient
Field Name |
Description |
Default Value |
Range/Valid Values |
Required |
|---|---|---|---|---|
z |
z-component of vector |
☐ |
||
x |
x-component of vector |
☐ |
||
y |
y-component of vector |
☐ |
reference_temperature¶
Description: Coefficient for the reference temperature for isotropic thermal expansion
Field Name |
Description |
Default Value |
Range/Valid Values |
Required |
|---|---|---|---|---|
constant |
The constant scalar value to use as the coefficient |
☐ |
||
component |
The vector component to which the scalar coefficient should be applied |
☐ |
Function Name |
Description |
Signature |
Required |
|---|---|---|---|
scalar_function |
The function to use for an mfem::FunctionCoefficient |
Double(Vector, Double) |
☐ |
vector_function |
The function to use for an mfem::VectorFunctionCoefficient |
Vector(Vector, Double) |
☐ |
vector_constant¶
Description: The constant vector to use as the coefficient
Field Name |
Description |
Default Value |
Range/Valid Values |
Required |
|---|---|---|---|---|
z |
z-component of vector |
☐ |
||
x |
x-component of vector |
☐ |
||
y |
y-component of vector |
☐ |
solid¶
Description: Finite deformation solid mechanics module
Field Name |
Description |
Default Value |
Range/Valid Values |
Required |
|---|---|---|---|---|
geometric_nonlin |
Flag to include geometric nonlinearities in the residual calculation. |
True |
☐ |
|
order |
polynomial order of the basis functions. |
1 |
1 to 3 |
☐ |
initial_velocity¶
Description: Coefficient for initial condition
Field Name |
Description |
Default Value |
Range/Valid Values |
Required |
|---|---|---|---|---|
constant |
The constant scalar value to use as the coefficient |
☐ |
||
component |
The vector component to which the scalar coefficient should be applied |
☐ |
Function Name |
Description |
Signature |
Required |
|---|---|---|---|
scalar_function |
The function to use for an mfem::FunctionCoefficient |
Double(Vector, Double) |
☐ |
vector_function |
The function to use for an mfem::VectorFunctionCoefficient |
Vector(Vector, Double) |
☐ |
vector_constant¶
Description: The constant vector to use as the coefficient
Field Name |
Description |
Default Value |
Range/Valid Values |
Required |
|---|---|---|---|---|
x |
x-component of vector |
☐ |
||
z |
z-component of vector |
☐ |
||
y |
y-component of vector |
☐ |
boundary_conds¶
Collection contents:¶
dynamics¶
Description: Parameters for mass matrix inversion
Field Name |
Description |
Default Value |
Range/Valid Values |
Required |
|---|---|---|---|---|
enforcement_method |
Time-varying constraint enforcement method to use |
☐ |
||
timestepper |
Timestepper (ODE) method to use |
☐ |
materials¶
Collection contents:¶
initial_displacement¶
Description: Coefficient for initial condition
Field Name |
Description |
Default Value |
Range/Valid Values |
Required |
|---|---|---|---|---|
constant |
The constant scalar value to use as the coefficient |
☐ |
||
component |
The vector component to which the scalar coefficient should be applied |
☐ |
Function Name |
Description |
Signature |
Required |
|---|---|---|---|
scalar_function |
The function to use for an mfem::FunctionCoefficient |
Double(Vector, Double) |
☐ |
vector_function |
The function to use for an mfem::VectorFunctionCoefficient |
Vector(Vector, Double) |
☐ |
vector_constant¶
Description: The constant vector to use as the coefficient
Field Name |
Description |
Default Value |
Range/Valid Values |
Required |
|---|---|---|---|---|
z |
z-component of vector |
☐ |
||
x |
x-component of vector |
☐ |
||
y |
y-component of vector |
☐ |
equation_solver¶
Description: Linear and Nonlinear stiffness Solver Parameters.
nonlinear¶
Description: Newton Equation Solver Parameters
Field Name |
Description |
Default Value |
Range/Valid Values |
Required |
|---|---|---|---|---|
solver_type |
Solver type (Newton|KINFullStep|KINLineSearch) |
Newton |
☐ |
|
print_level |
Nonlinear print level. |
0 |
☐ |
|
max_iter |
Maximum iterations for the Newton solve. |
500 |
☐ |
|
rel_tol |
Relative tolerance for the Newton solve. |
0.010000 |
☐ |
|
abs_tol |
Absolute tolerance for the Newton solve. |
0.000100 |
☐ |
linear¶
Description: Linear Equation Solver Parameters
Field Name |
Description |
Default Value |
Range/Valid Values |
Required |
|---|---|---|---|---|
type |
The type of solver parameters to use (iterative|direct) |
iterative, direct |
☑ |
direct_options¶
Description: Direct solver parameters
Field Name |
Description |
Default Value |
Range/Valid Values |
Required |
|---|---|---|---|---|
print_level |
Linear print level. |
0 |
☐ |
iterative_options¶
Description: Iterative solver parameters
Field Name |
Description |
Default Value |
Range/Valid Values |
Required |
|---|---|---|---|---|
prec_type |
Preconditioner type (JacobiSmoother|L1JacobiSmoother|AMG|ILU). |
JacobiSmoother |
☐ |
|
solver_type |
Solver type (gmres|minres|cg). |
gmres |
☐ |
|
print_level |
Linear print level. |
0 |
☐ |
|
rel_tol |
Relative tolerance for the linear solve. |
0.000001 |
☐ |
|
max_iter |
Maximum iterations for the linear solve. |
5000 |
☐ |
|
abs_tol |
Absolute tolerance for the linear solve. |
0.000000 |
☐ |
heat_transfer¶
Description: Heat transfer module
Field Name |
Description |
Default Value |
Range/Valid Values |
Required |
|---|---|---|---|---|
order |
Order degree of the finite elements. |
1 |
1 to 8 |
☐ |
boundary_conds¶
Collection contents:¶
dynamics¶
Description: Parameters for mass matrix inversion
Field Name |
Description |
Default Value |
Range/Valid Values |
Required |
|---|---|---|---|---|
enforcement_method |
Time-varying constraint enforcement method to use |
☐ |
||
timestepper |
Timestepper (ODE) method to use |
☐ |
equation_solver¶
Description: Linear and Nonlinear stiffness Solver Parameters.
nonlinear¶
Description: Newton Equation Solver Parameters
Field Name |
Description |
Default Value |
Range/Valid Values |
Required |
|---|---|---|---|---|
solver_type |
Solver type (Newton|KINFullStep|KINLineSearch) |
Newton |
☐ |
|
max_iter |
Maximum iterations for the Newton solve. |
500 |
☐ |
|
rel_tol |
Relative tolerance for the Newton solve. |
0.010000 |
☐ |
|
print_level |
Nonlinear print level. |
0 |
☐ |
|
abs_tol |
Absolute tolerance for the Newton solve. |
0.000100 |
☐ |
linear¶
Description: Linear Equation Solver Parameters
Field Name |
Description |
Default Value |
Range/Valid Values |
Required |
|---|---|---|---|---|
type |
The type of solver parameters to use (iterative|direct) |
iterative, direct |
☑ |
direct_options¶
Description: Direct solver parameters
Field Name |
Description |
Default Value |
Range/Valid Values |
Required |
|---|---|---|---|---|
print_level |
Linear print level. |
0 |
☐ |
iterative_options¶
Description: Iterative solver parameters
Field Name |
Description |
Default Value |
Range/Valid Values |
Required |
|---|---|---|---|---|
solver_type |
Solver type (gmres|minres|cg). |
gmres |
☐ |
|
max_iter |
Maximum iterations for the linear solve. |
5000 |
☐ |
|
prec_type |
Preconditioner type (JacobiSmoother|L1JacobiSmoother|AMG|ILU). |
JacobiSmoother |
☐ |
|
rel_tol |
Relative tolerance for the linear solve. |
0.000001 |
☐ |
|
print_level |
Linear print level. |
0 |
☐ |
|
abs_tol |
Absolute tolerance for the linear solve. |
0.000000 |
☐ |
initial_temperature¶
Description: Coefficient for initial condition
Field Name |
Description |
Default Value |
Range/Valid Values |
Required |
|---|---|---|---|---|
constant |
The constant scalar value to use as the coefficient |
☐ |
||
component |
The vector component to which the scalar coefficient should be applied |
☐ |
Function Name |
Description |
Signature |
Required |
|---|---|---|---|
scalar_function |
The function to use for an mfem::FunctionCoefficient |
Double(Vector, Double) |
☐ |
vector_function |
The function to use for an mfem::VectorFunctionCoefficient |
Vector(Vector, Double) |
☐ |
vector_constant¶
Description: The constant vector to use as the coefficient
Field Name |
Description |
Default Value |
Range/Valid Values |
Required |
|---|---|---|---|---|
z |
z-component of vector |
☐ |
||
x |
x-component of vector |
☐ |
||
y |
y-component of vector |
☐ |
source¶
Description: Scalar source term (RHS of the heat transfer PDE)
Field Name |
Description |
Default Value |
Range/Valid Values |
Required |
|---|---|---|---|---|
constant |
The constant scalar value to use as the coefficient |
☐ |
||
component |
The vector component to which the scalar coefficient should be applied |
☐ |
Function Name |
Description |
Signature |
Required |
|---|---|---|---|
scalar_function |
The function to use for an mfem::FunctionCoefficient |
Double(Vector, Double) |
☐ |
vector_function |
The function to use for an mfem::VectorFunctionCoefficient |
Vector(Vector, Double) |
☐ |
vector_constant¶
Description: The constant vector to use as the coefficient
Field Name |
Description |
Default Value |
Range/Valid Values |
Required |
|---|---|---|---|---|
z |
z-component of vector |
☐ |
||
x |
x-component of vector |
☐ |
||
y |
y-component of vector |
☐ |
heat_transfer¶
Description: Heat transfer module
Field Name |
Description |
Default Value |
Range/Valid Values |
Required |
|---|---|---|---|---|
order |
Order degree of the finite elements. |
1 |
1 to 8 |
☐ |
initial_temperature¶
Description: Coefficient for initial condition
Field Name |
Description |
Default Value |
Range/Valid Values |
Required |
|---|---|---|---|---|
constant |
The constant scalar value to use as the coefficient |
☐ |
||
component |
The vector component to which the scalar coefficient should be applied |
☐ |
Function Name |
Description |
Signature |
Required |
|---|---|---|---|
scalar_function |
The function to use for an mfem::FunctionCoefficient |
Double(Vector, Double) |
☐ |
vector_function |
The function to use for an mfem::VectorFunctionCoefficient |
Vector(Vector, Double) |
☐ |
vector_constant¶
Description: The constant vector to use as the coefficient
Field Name |
Description |
Default Value |
Range/Valid Values |
Required |
|---|---|---|---|---|
z |
z-component of vector |
☐ |
||
x |
x-component of vector |
☐ |
||
y |
y-component of vector |
☐ |
boundary_conds¶
Collection contents:¶
The input schema defines a collection of this container. For brevity, only one instance is displayed here.
Field Name |
Description |
Default Value |
Range/Valid Values |
Required |
|---|---|---|---|---|
constant |
The constant scalar value to use as the coefficient |
☐ |
||
component |
The vector component to which the scalar coefficient should be applied |
☐ |
Function Name |
Description |
Signature |
Required |
|---|---|---|---|
scalar_function |
The function to use for an mfem::FunctionCoefficient |
Double(Vector, Double) |
☐ |
vector_function |
The function to use for an mfem::VectorFunctionCoefficient |
Vector(Vector, Double) |
☐ |
attrs¶
Collection contents:¶
Field Name |
Description |
Default Value |
Range/Valid Values |
Required |
|---|---|---|---|---|
1 |
☐ |
vector_constant¶
Description: The constant vector to use as the coefficient
Field Name |
Description |
Default Value |
Range/Valid Values |
Required |
|---|---|---|---|---|
x |
x-component of vector |
☐ |
||
z |
z-component of vector |
☐ |
||
y |
y-component of vector |
☐ |
equation_solver¶
Description: Linear and Nonlinear stiffness Solver Parameters.
nonlinear¶
Description: Newton Equation Solver Parameters
Field Name |
Description |
Default Value |
Range/Valid Values |
Required |
|---|---|---|---|---|
solver_type |
Solver type (Newton|KINFullStep|KINLineSearch) |
Newton |
☐ |
|
print_level |
Nonlinear print level. |
0 |
☐ |
|
max_iter |
Maximum iterations for the Newton solve. |
500 |
☐ |
|
rel_tol |
Relative tolerance for the Newton solve. |
0.010000 |
☐ |
|
abs_tol |
Absolute tolerance for the Newton solve. |
0.000100 |
☐ |
linear¶
Description: Linear Equation Solver Parameters
Field Name |
Description |
Default Value |
Range/Valid Values |
Required |
|---|---|---|---|---|
type |
The type of solver parameters to use (iterative|direct) |
iterative, direct |
☑ |
direct_options¶
Description: Direct solver parameters
Field Name |
Description |
Default Value |
Range/Valid Values |
Required |
|---|---|---|---|---|
print_level |
Linear print level. |
0 |
☐ |
iterative_options¶
Description: Iterative solver parameters
Field Name |
Description |
Default Value |
Range/Valid Values |
Required |
|---|---|---|---|---|
prec_type |
Preconditioner type (JacobiSmoother|L1JacobiSmoother|AMG|ILU). |
JacobiSmoother |
☐ |
|
solver_type |
Solver type (gmres|minres|cg). |
gmres |
☐ |
|
print_level |
Linear print level. |
0 |
☐ |
|
max_iter |
Maximum iterations for the linear solve. |
5000 |
☐ |
|
rel_tol |
Relative tolerance for the linear solve. |
0.000001 |
☐ |
|
abs_tol |
Absolute tolerance for the linear solve. |
0.000000 |
☐ |
dynamics¶
Description: Parameters for mass matrix inversion
Field Name |
Description |
Default Value |
Range/Valid Values |
Required |
|---|---|---|---|---|
enforcement_method |
Time-varying constraint enforcement method to use |
☐ |
||
timestepper |
Timestepper (ODE) method to use |
☐ |
source¶
Description: Scalar source term (RHS of the heat transfer PDE)
Field Name |
Description |
Default Value |
Range/Valid Values |
Required |
|---|---|---|---|---|
constant |
The constant scalar value to use as the coefficient |
☐ |
||
component |
The vector component to which the scalar coefficient should be applied |
☐ |
Function Name |
Description |
Signature |
Required |
|---|---|---|---|
scalar_function |
The function to use for an mfem::FunctionCoefficient |
Double(Vector, Double) |
☐ |
vector_function |
The function to use for an mfem::VectorFunctionCoefficient |
Vector(Vector, Double) |
☐ |
vector_constant¶
Description: The constant vector to use as the coefficient
Field Name |
Description |
Default Value |
Range/Valid Values |
Required |
|---|---|---|---|---|
z |
z-component of vector |
☐ |
||
x |
x-component of vector |
☐ |
||
y |
y-component of vector |
☐ |
main_mesh¶
Description: The main mesh for the problem
Field Name |
Description |
Default Value |
Range/Valid Values |
Required |
|---|---|---|---|---|
mesh |
Path to Mesh file |
☐ |
||
type |
Type of mesh |
ball, box, disk, file |
☑ |
|
approx_elements |
Approximate number of elements in an n-ball mesh |
☐ |
||
ser_ref_levels |
Number of times to refine the mesh uniformly in serial. |
0 |
☐ |
|
par_ref_levels |
Number of times to refine the mesh uniformly in parallel. |
0 |
☐ |
size¶
Field Name |
Description |
Default Value |
Range/Valid Values |
Required |
|---|---|---|---|---|
x |
Size in the x-dimension |
☐ |
||
z |
Size in the z-dimension |
☐ |
||
y |
Size in the y-dimension |
☐ |
elements¶
Field Name |
Description |
Default Value |
Range/Valid Values |
Required |
|---|---|---|---|---|
z |
z-dimension |
☐ |
||
x |
x-dimension |
☐ |
||
y |
y-dimension |
☐ |
solid¶
Description: Finite deformation solid mechanics module
Field Name |
Description |
Default Value |
Range/Valid Values |
Required |
|---|---|---|---|---|
geometric_nonlin |
Flag to include geometric nonlinearities in the residual calculation. |
True |
☐ |
|
order |
polynomial order of the basis functions. |
1 |
1 to 3 |
☐ |
boundary_conds¶
Collection contents:¶
The input schema defines a collection of this container. For brevity, only one instance is displayed here.
Field Name |
Description |
Default Value |
Range/Valid Values |
Required |
|---|---|---|---|---|
constant |
The constant scalar value to use as the coefficient |
☐ |
||
component |
The vector component to which the scalar coefficient should be applied |
☐ |
Function Name |
Description |
Signature |
Required |
|---|---|---|---|
scalar_function |
The function to use for an mfem::FunctionCoefficient |
Double(Vector, Double) |
☐ |
vector_function |
The function to use for an mfem::VectorFunctionCoefficient |
Vector(Vector, Double) |
☐ |
attrs¶
Collection contents:¶
Field Name |
Description |
Default Value |
Range/Valid Values |
Required |
|---|---|---|---|---|
1 |
☐ |
vector_constant¶
Description: The constant vector to use as the coefficient
Field Name |
Description |
Default Value |
Range/Valid Values |
Required |
|---|---|---|---|---|
z |
z-component of vector |
☐ |
||
x |
x-component of vector |
☐ |
||
y |
y-component of vector |
☐ |
initial_displacement¶
Description: Coefficient for initial condition
Field Name |
Description |
Default Value |
Range/Valid Values |
Required |
|---|---|---|---|---|
constant |
The constant scalar value to use as the coefficient |
☐ |
||
component |
The vector component to which the scalar coefficient should be applied |
☐ |
Function Name |
Description |
Signature |
Required |
|---|---|---|---|
scalar_function |
The function to use for an mfem::FunctionCoefficient |
Double(Vector, Double) |
☐ |
vector_function |
The function to use for an mfem::VectorFunctionCoefficient |
Vector(Vector, Double) |
☐ |
vector_constant¶
Description: The constant vector to use as the coefficient
Field Name |
Description |
Default Value |
Range/Valid Values |
Required |
|---|---|---|---|---|
z |
z-component of vector |
☐ |
||
x |
x-component of vector |
☐ |
||
y |
y-component of vector |
☐ |
dynamics¶
Description: Parameters for mass matrix inversion
Field Name |
Description |
Default Value |
Range/Valid Values |
Required |
|---|---|---|---|---|
enforcement_method |
Time-varying constraint enforcement method to use |
☐ |
||
timestepper |
Timestepper (ODE) method to use |
☐ |
materials¶
Collection contents:¶
The input schema defines a collection of this container. For brevity, only one instance is displayed here.
Field Name |
Description |
Default Value |
Range/Valid Values |
Required |
|---|---|---|---|---|
sigma_y |
Yield stress |
☐ |
||
Hi |
Isotropic hardening constant |
☐ |
||
E |
Young's modulus |
☐ |
||
nu |
Poisson's ratio |
☐ |
||
Hk |
Kinematic hardening constant |
☐ |
||
mu |
The shear modulus |
☐ |
||
density |
Initial mass density |
☐ |
||
model |
The model of material (e.g. NeoHookean) |
☑ |
||
K |
The bulk modulus |
☐ |
hardening¶
Description: Hardening law
Field Name |
Description |
Default Value |
Range/Valid Values |
Required |
|---|---|---|---|---|
strain_constant |
Constant dictating how fast the exponential decays |
☐ |
||
sigma_sat |
Saturation value of flow strength |
☐ |
||
eps0 |
Reference value of accumulated plastic strain |
☐ |
||
n |
Hardening index in reciprocal form |
☐ |
||
law |
Name of the hardening law (e.g. PowerLawHardening, VoceHardening) |
☑ |
||
sigma_y |
Yield strength |
☐ |
initial_velocity¶
Description: Coefficient for initial condition
Field Name |
Description |
Default Value |
Range/Valid Values |
Required |
|---|---|---|---|---|
constant |
The constant scalar value to use as the coefficient |
☐ |
||
component |
The vector component to which the scalar coefficient should be applied |
☐ |
Function Name |
Description |
Signature |
Required |
|---|---|---|---|
scalar_function |
The function to use for an mfem::FunctionCoefficient |
Double(Vector, Double) |
☐ |
vector_function |
The function to use for an mfem::VectorFunctionCoefficient |
Vector(Vector, Double) |
☐ |
vector_constant¶
Description: The constant vector to use as the coefficient
Field Name |
Description |
Default Value |
Range/Valid Values |
Required |
|---|---|---|---|---|
z |
z-component of vector |
☐ |
||
x |
x-component of vector |
☐ |
||
y |
y-component of vector |
☐ |
equation_solver¶
Description: Linear and Nonlinear stiffness Solver Parameters.
nonlinear¶
Description: Newton Equation Solver Parameters
Field Name |
Description |
Default Value |
Range/Valid Values |
Required |
|---|---|---|---|---|
solver_type |
Solver type (Newton|KINFullStep|KINLineSearch) |
Newton |
☐ |
|
max_iter |
Maximum iterations for the Newton solve. |
500 |
☐ |
|
rel_tol |
Relative tolerance for the Newton solve. |
0.010000 |
☐ |
|
print_level |
Nonlinear print level. |
0 |
☐ |
|
abs_tol |
Absolute tolerance for the Newton solve. |
0.000100 |
☐ |
linear¶
Description: Linear Equation Solver Parameters
Field Name |
Description |
Default Value |
Range/Valid Values |
Required |
|---|---|---|---|---|
type |
The type of solver parameters to use (iterative|direct) |
iterative, direct |
☑ |
direct_options¶
Description: Direct solver parameters
Field Name |
Description |
Default Value |
Range/Valid Values |
Required |
|---|---|---|---|---|
print_level |
Linear print level. |
0 |
☐ |
iterative_options¶
Description: Iterative solver parameters
Field Name |
Description |
Default Value |
Range/Valid Values |
Required |
|---|---|---|---|---|
solver_type |
Solver type (gmres|minres|cg). |
gmres |
☐ |
|
print_level |
Linear print level. |
0 |
☐ |
|
max_iter |
Maximum iterations for the linear solve. |
5000 |
☐ |
|
rel_tol |
Relative tolerance for the linear solve. |
0.000001 |
☐ |
|
prec_type |
Preconditioner type (JacobiSmoother|L1JacobiSmoother|AMG|ILU). |
JacobiSmoother |
☐ |
|
abs_tol |
Absolute tolerance for the linear solve. |
0.000000 |
☐ |