Parameters

CTF_file_path

Input of: sample_texture, sample_orientations

EBSD_phase

Input of: sample_texture, sample_texture, sample_orientations, sample_orientations

EBSD_reference_frame_transformation

Input of: sample_texture, sample_texture, sample_orientations, sample_orientations

EBSD_rotation

Input of: sample_texture, sample_texture, sample_orientations, sample_orientations

ODF_mat_file_path

Input of: sample_texture

VE_grid_size

type: list, length: 2 or 3 (of: int)

Condition: ConditionAnd(ValueDataType.equal_to(value=<class 'list'>), ValueLength.in_(value=[2, 3]))

Number of simulation pixels (voxels) in each of the x, y(, z) directions.

Input of: generate_volume_element

VE_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

Input of: simulate_VE_loading, simulate_VE_loading

VE_size

type: list, length: 2 or 3 (of: float)

Condition: ConditionAnd(ValueDataType.equal_to(value=<class 'list'>), ValueLength.in_(value=[2, 3]))

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

compile

Input of: sample_texture, sample_texture, sample_texture, sample_texture, visualise_orientations, sample_orientations, sample_orientations, sample_texture

damask_log

Output of: 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

type: dict (value: str)

Condition: ConditionAnd(ValueDataType.equal_to(value=<class 'dict'>), Key.in_(value=['mechanical', 'thermal', 'damage']))

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

Input of: simulate_VE_loading, simulate_VE_loading

damask_viz_result

Output of: simulate_VE_loading

dump_path

Input of: dump_all_yield_stresses

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

homog_label

type: str

Condition: ValueDataType.equal_to(value=<class 'str'>)

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

Input of: simulate_VE_loading, simulate_VE_loading

load_case

Input of: define_load_case, simulate_VE_loading, simulate_VE_loading

Constructors:

• LoadCase

• LoadCase.biaxial

• LoadCase.example_uniaxial

• LoadCase.multistep

• LoadCase.planar_2D

• LoadCase.plane_strain

• LoadCase.random_2D

• LoadCase.random_3D

• LoadCase.uniaxial

• LoadCase.uniaxial_cyclic

microstructure_seeds

Input of: generate_volume_element

Output of: generate_microstructure_seeds

Constructors:

• MicrostructureSeeds

• MicrostructureSeeds.from_JSON_like

• MicrostructureSeeds.from_file

• MicrostructureSeeds.from_random

num_grains

type: int

Condition: ValueDataType.equal_to(value=<class 'int'>)

The integer number of grains to include.

Input of: generate_microstructure_seeds

num_orientations

Input of: sample_texture, sample_texture, sample_texture, sample_texture, generate_orientations, sample_orientations, sample_orientations, sample_texture

orientations

Input of: generate_volume_element, visualise_orientations, generate_volume_element

Output of: sample_texture, sample_texture, sample_texture, sample_texture, generate_orientations, sample_orientations, sample_orientations, sample_texture

Constructors:

• Orientations

• Orientations.from_JSON_like

• Orientations.from_file

• Orientations.from_random

• Orientations.save_from_HDF5_group

phase_label

type: str

Condition: ValueDataType.equal_to(value=<class 'str'>)

The string phase label to associated with e.g. the microstructure seed points.

Input of: generate_microstructure_seeds, generate_volume_element

specimen_symmetry

Input of: sample_texture, sample_texture, sample_texture, sample_orientations, sample_orientations, sample_texture

volume_element

type: dict

Condition: ValueDataType.equal_to(value=<class 'dict'>)

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

yield_function_name

Input of: fit_yield_function

yield_point

Input of: dump_all_yield_stresses

yield_point_criteria

Input of: fit_yield_function