Parameters#
CRC_file_path#
Path to channel reconstruction (Oxford Instruments binary) file.
Input of: sample_texture, sample_orientations
CSV_arguments#
Input of: read_tensile_test
CSV_file_path#
Path to CSV (possibly an Oxford Instruments single orientation) file.
Input of: read_tensile_test
CTF_file_path#
Path to CTF (HKL single orientation) file.
Input of: sample_texture, sample_orientations
DIC#
Digital image correlation data descriptor.
Input of: load_microstructure
EBSD#
Electron backscatter diffraction data descriptor.
Input of: load_microstructure, load_microstructure
EBSD_phase#
Electron backscatter diffraction phase.
Input of: sample_texture, sample_texture, sample_orientations, sample_orientations
EBSD_reference_frame_transformation#
Electron backscatter diffraction referemce frame transformation.
Input of: sample_texture, sample_texture, sample_orientations, sample_orientations
EBSD_rotation#
Description of the rotation in the electron backscatter diffraction model. A dict with keys "euler_angles_deg" (list, optional) "keep_XY" (bool), or "keep_euler" (bool).
Input of: sample_texture, sample_texture, sample_orientations, sample_orientations
IPF_reference_direction#
Input of: visualise_orientations
ODF_components#
Information used to control the orientation distribution function.
Input of: sample_texture
ODF_mat_file_path#
Path to ODF material file.
Input of: sample_texture
VE_grid_size#
Number of simulation pixels (voxels) in each of the x, y(, z) directions.
Input of: generate_volume_element
VE_response#
Volume element response.
Input of: fit_single_crystal_parameters, dump_all_yield_stresses, fit_yield_function
Output of: simulate_VE_loading, simulate_VE_loading
VE_response_data#
This parameter is a dictionary of values that are the optional arguments to damask_parse.read_HDF5_file
(which should be consulted for details). Keys should be one of "geom_path"
, "volume_data"
, "phase_data"
, "field_data"
, "grain_data"
, or "incremental_data"
(now deprecated).
Input of: simulate_VE_loading, simulate_VE_loading
VE_size#
Size of the simulation box in each of the x, y(, z) directions.
Example: For a simulation box that is twice as long (i.e. elongated) in the y-direction as in the x- and z-directions, use: [1.0, 2.0, 1.0]
.
Input of: generate_microstructure_seeds
buffer_sizes#
Size of buffer on each face [-x, +x, -y, +y, -z, +z]
.
Input of: modify_VE
colourbar_limits#
Uses API deprecated by MTEX. Might not work at all.
Input of: visualise_orientations
compile#
Whether to compile.
Input of: sample_texture, sample_texture, sample_texture, sample_texture, visualise_orientations, sample_orientations, sample_orientations, sample_texture
crystal_symmetry#
Single parameter to make an instance of MTEX crystalSymmetry
.
Example: cubic
- Cubic symmetry
Example: hexagonal
- Hexagonal symmetry
Input of: sample_texture, visualise_orientations, sample_texture
damask_log#
Output of: simulate_VE_loading
damask_numerics#
Input of: simulate_VE_loading, simulate_VE_loading
damask_phases#
Input of: simulate_VE_loading, simulate_VE_loading
damask_post_processing#
Input of: simulate_VE_loading, simulate_VE_loading
damask_post_processing_result#
Output of: simulate_VE_loading
damask_solver#
A dictionary that specifies which solver to use, for each considered physical phenomenon (mechanical
, thermal
, or damage
).
Example: To use the spectral_polarization
mechanical solver instead of the default spectral_basic
solver, set to: {"mechanical": "spectral_polarization"}
Input of: simulate_VE_loading, simulate_VE_loading
damask_viz#
Dictionary or list of dictionaries describing particular visualizations. Keys should be increments
, phases
, homogenizations
, or fields
; all are optional.
Input of: simulate_VE_loading, simulate_VE_loading
damask_viz_result#
Output of: simulate_VE_loading
depth#
Input of: generate_volume_element
dump_path#
Where to write dump data.
Input of: dump_all_yield_stresses
eng_strain_col_index#
CSV column index.
Input of: read_tensile_test
eng_stress_col_index#
CSV column index.
Input of: read_tensile_test
find_grains_algorithm#
Input of: load_microstructure
fit_yield_fixed_parameters#
Input of: fit_yield_function
fit_yield_initial_parameters#
Input of: fit_yield_function
fit_yield_opt_parameters#
Input of: fit_yield_function
fitted_yield_functions#
Output of: fit_yield_function
grid_size#
Number of simulation pixels (voxels) in each of the x, y(, z) directions.
Input of: generate_volume_element
homog_label#
This parameter associates a string label with each grain that determines which homogenization scheme should be used. The homogenization schemes to be employed by the crystal plasticity simulation are then defined according to these labels.
Example: For a full-field simulation, where there is no mechanical homogenization we typically use the label 'SX
'.
Input of: generate_volume_element, generate_volume_element, modify_VE
homogenization#
Dictionary whose keys are homogenization scheme labels and whose values are dictionaries that specify the homogenization parameters for that scheme.
Input of: simulate_VE_loading, simulate_VE_loading
image_axes#
Input of: generate_volume_element
initial_damping#
List of initial damping parameters.
Example: The default value is [2, 1, 0.5]
Input of: fit_single_crystal_parameters
levenberg_marquardt_fitter#
Output of: fit_single_crystal_parameters
load_case#
Input of: define_load_case, simulate_VE_loading, simulate_VE_loading
Constructors:
microstructure_image#
Input of: generate_volume_element
Output of: load_microstructure, load_microstructure
microstructure_seeds#
Input of: generate_volume_element, define_microstructure_seeds
Output of: generate_microstructure_seeds
Constructors:
new_grid_size#
New number of simulation pixels (voxels) in each of the x, y(, z) directions.
Input of: modify_VE
num_grains#
The integer number of grains to include.
Input of: generate_microstructure_seeds
num_orientations#
Number of orientations.
Input of: sample_texture, sample_texture, sample_texture, sample_texture, generate_orientations, sample_orientations, sample_orientations, sample_texture
order#
Order to add the zones in.
Input of: modify_VE
orientations#
Input of: generate_volume_element, visualise_orientations, define_orientations, generate_volume_element, generate_rve
Output of: sample_texture, sample_texture, sample_texture, sample_texture, generate_orientations, sample_orientations, sample_orientations, sample_texture
Constructors:
origin#
Location of the origin of the grid.
Input of: generate_volume_element
path#
Path to file to process.
Input of: visualise_VE
periodic#
Input of: generate_volume_element
phase_ids#
Phase of each buffer. Relative, so 1 is the first new phase and so on
Input of: modify_VE
phase_label#
The string phase label to associated with e.g. the microstructure seed points.
Input of: generate_microstructure_seeds, generate_volume_element
phase_label_mapping#
Mapping from phase labels in the microstructure_image
to phase labels for created in the VE.
Input of: generate_volume_element
phase_labels#
Labels of the new phases.
Input of: modify_VE
phase_statistics#
A list of dictionaries giving the statistics for the various phases.
Each dictionary must have the keys type
, name
, crystal_structure
, and volume_fraction
.
Dictionaries of type: primary
must also have a size_distribution
key.
Dictionaries of type: precipitate
must also have the keys size_distribution
, radial_distribution_function
, and number_fraction_on_boundary
.
Input of: generate_volume_element
plastic_range#
Input of: read_tensile_test
pole_figure_directions#
[list-value]#
Input of: visualise_orientations
precipitates#
Input of: generate_volume_element
resolution#
Input of: generate_volume_element
root_path#
Location to resolve filenames with respect to.
Input of: load_microstructure, load_microstructure
scale_morphology#
Input of: generate_volume_element
scale_update_size#
Input of: generate_volume_element
scaling_factor#
Scaling factor.
Input of: load_microstructure, load_microstructure
single_crystal_parameters#
Input of: simulate_VE_loading, simulate_VE_loading, fit_single_crystal_parameters
Output of: fit_single_crystal_parameters
Constructors:
size#
Number of simulation pixels (voxels) in each of the x, y(, z) directions.
Input of: generate_volume_element
specimen_symmetry#
The symmetry of the specimen to sample, as understood by MTEX specimenSymmetry
.
Example: cubic
Example: orthorhombic
Input of: sample_texture, sample_texture, sample_texture, sample_orientations, sample_orientations, sample_texture
stress_units#
Units to use for stress values.
Example: The normal value here is Pascals, "Pa"
Input of: read_tensile_test
tensile_test#
Input of: fit_single_crystal_parameters
Output of: read_tensile_test
transform_type#
Transformation type.
Input of: load_microstructure
true_strain_col_index#
CSV column index.
Input of: read_tensile_test
true_stress_col_index#
CSV column index.
Input of: read_tensile_test
use_contours#
Whether to use countours when visualising orientations.
Input of: visualise_orientations
use_one_colourbar#
Whether to use a single colour bar when visualising orientations.
Input of: visualise_orientations
volume_element#
Voxelated volume element
Input of: visualise_VE, simulate_VE_loading, simulate_VE_loading, modify_VE, modify_VE
Output of: generate_volume_element, generate_volume_element, generate_volume_element, modify_VE, modify_VE, generate_rve
yield_function_name#
The name of the yield function to fit to the data.
Example: VonMises
- von Mises yield criteron
Example: Tresca
- Tresca ductile failure criterion
Example: Hosford
- Hosford yield criterion
Example: Barlat_Yld91
- Barlat anisotropic yield model
Example: Barlat_Yld2000_2D
- Barlat planar stress yield model
Example: Barlat_Yld2004_18p
- Barlat linear transformation yield functions
Example: Hill1979
- Generalised Hill yield criterion
Example: Hill1948
- Quadratic Hill yield criterion
Input of: fit_yield_function
yield_point#
Input of: dump_all_yield_stresses
yield_point_criteria#
Input of: fit_yield_function