calibration

AbstractCalibrationFitness

Bases: FitnessBase, CalibrationOptionsProxy

experiments instance-attribute

experiments: List[Experiment]

The experiments.

io instance-attribute

io: ModelBaseIO

The model io.

check

check(simx: ndarray, simy: ndarray) -> bool

Validate the simulated data.

create classmethod

create(fitness: Self | Type[Self] | str | None = None, **kwargs) -> Self

evaluate

evaluate(
    results: Dict[str, SVExporter | bool],
) -> Tuple[Dict[str, Dict[str, float]], Dict[str, Dict[str, float]]]

get

get(
    x: str, y: str, experiment: Experiment, line_name: str, sv: SVExporter
) -> Tuple[ndarray, ndarray, ndarray, ndarray]

Get experimental and simulated data.

isSmooth

isSmooth(x: ndarray, y: ndarray) -> bool

Check if the data is smooth.

parseOptimizeKeys

parseOptimizeKeys()

Parse the keys of the fitness function.

preprocess

preprocess(
    expx: ndarray, expy: ndarray, simx: ndarray, simy: ndarray
) -> Tuple[ndarray, ndarray, ndarray, ndarray]

Preprocess the experimental and simulated data.

PARAMETER	DESCRIPTION
expx	The x-axis of the experimental data. TYPE: ndarray
expy	The y-axis of the experimental data. TYPE: ndarray
simx	The x-axis of the simulated data. TYPE: ndarray
simy	The y-axis of the simulated data. TYPE: ndarray

RETURNS	DESCRIPTION
Tuple[ndarray, ndarray, ndarray, ndarray]	The preprocessed data.

run

run(
    x: Iterable | dict, *args, return_results: bool = False, **kwargs
) -> float | Tuple[float, Dict[str, SVExporter]]

serialize_data_get_kwargs

serialize_data_get_kwargs(value: Dict[str, Any]) -> Dict[str, Any]

serialize_keys

serialize_keys(value: List[str | CalibrationKey]) -> List[str]

serialize_lognormal_parameters

serialize_lognormal_parameters(value: List[str | CalibrationKey]) -> List[str]

setCalculationOptions classmethod

setCalculationOptions(
    model: Union["MicromechanicalBase", "ElastoplasticModel"],
    *,
    errstate: Literal["raise", "warn", "ignore"] = "raise",
    **kwargs
)

Set the calculation options for the micromechanical model, the contact law, the integration, or the material.

PARAMETER	DESCRIPTION
model	The micromechanical model. TYPE: Union['MicromechanicalBase', 'ElastoplasticModel']
errstate	How to handle unsupported options. TYPE: ('raise', 'warn', 'ignore') DEFAULT: "raise"
kwargs	The calculation options for the micromechanical model, the contact law, or the material. DEFAULT: {}

setModelParameters

setModelParameters(
    model: Union["MicromechanicalBase", "ElastoplasticModel"],
    x: Iterable | dict,
    experiment: Experiment,
)

Set the material parameters (for the given experiment) to the model.

similarity

similarity(
    experiment_name: str,
    line_name: str,
    expx: ndarray,
    expy: ndarray,
    simx: ndarray,
    simy: ndarray,
) -> float

Calculate the similarity between the experimental and simulated data.

PARAMETER	DESCRIPTION
experiment_name	The name of the experiment. TYPE: str
line_name	The name of the line. TYPE: str
expx	The x-axis of the experimental data. TYPE: ndarray
expy	The y-axis of the experimental data. TYPE: ndarray
simx	The x-axis of the simulated data. TYPE: ndarray
simy	The y-axis of the simulated data. TYPE: ndarray

RETURNS	DESCRIPTION
float	The similarity value.

simulate

simulate(x: Iterable | dict) -> Dict[str, SVExporter | bool]

Simulate the model and return the results as a dictionary of SVExporter objects. If the simulation fails, return False instead.

validateOptions

validateOptions()

Validate the configurations.

validate_data_get_kwargs classmethod

validate_data_get_kwargs(value: Dict[str, Any])

validate_keys classmethod

validate_keys(value: List[str | CalibrationKey])

validate_lognormal_parameters classmethod

validate_lognormal_parameters(value: List[str | CalibrationKey])

weight

weight(
    expx: ndarray,
    expy: ndarray,
    simx: ndarray,
    simy: ndarray,
    experiment_name: str,
    line_name: str,
) -> float

Custom weight for the fitness.

CalibrationFitnessOptions

Bases: TypedDict

check_smoothness instance-attribute

check_smoothness: NotRequired[bool]

data_get_kwargs instance-attribute

data_get_kwargs: NotRequired[Dict[str, Any]]

error_fitness instance-attribute

error_fitness: NotRequired[float]

error_raise instance-attribute

error_raise: NotRequired[bool]

experiment_excludes instance-attribute

experiment_excludes: NotRequired[List[str]]

experiment_get_kwargs instance-attribute

experiment_get_kwargs: NotRequired[Dict[str, Any]]

experiment_includes instance-attribute

experiment_includes: NotRequired[List[str] | None]

experiment_options instance-attribute

experiment_options: NotRequired[Dict[str, Dict[str, Any]]]

experiment_weights instance-attribute

experiment_weights: NotRequired[Dict[str, float]]

line_additions instance-attribute

line_additions: NotRequired[Dict[str, Tuple[str, str]]]

line_clip_state_variables instance-attribute

line_clip_state_variables: NotRequired[Dict[str, Tuple[float, float]]]

line_clip_xydata instance-attribute

line_clip_xydata: NotRequired[List[str]]

line_ensure_increasing_xdata instance-attribute

line_ensure_increasing_xdata: NotRequired[List[str]]

line_excludes instance-attribute

line_excludes: NotRequired[List[str]]

line_experiment_additions instance-attribute

line_experiment_additions: NotRequired[Dict[str, Dict[str, Tuple[str, str]]]]

line_experiment_clip_state_variables instance-attribute

line_experiment_clip_state_variables: NotRequired[
    Dict[str, Dict[str, Tuple[float, float]]]
]

line_experiment_clip_xydata instance-attribute

line_experiment_clip_xydata: NotRequired[Dict[str, List[str]]]

line_experiment_ensure_increasing_xdata instance-attribute

line_experiment_ensure_increasing_xdata: NotRequired[Dict[str, List[str]]]

line_experiment_excludes instance-attribute

line_experiment_excludes: NotRequired[Dict[str, List[str]]]

line_experiment_includes instance-attribute

line_experiment_includes: NotRequired[Dict[str, List[str]]]

line_experiment_override_xydata instance-attribute

line_experiment_override_xydata: NotRequired[
    Dict[str, Dict[str, Tuple[List[float], List[float]]]]
]

line_experiment_swap_xydata_to_ensure_increasing_xdata instance-attribute

line_experiment_swap_xydata_to_ensure_increasing_xdata: NotRequired[
    Dict[str, List[str]]
]

line_experiment_weights instance-attribute

line_experiment_weights: NotRequired[Dict[str, Dict[str, float]]]

line_experiment_xptps instance-attribute

line_experiment_xptps: NotRequired[Dict[str, Dict[str, float]]]

line_experiment_xys instance-attribute

line_experiment_xys: NotRequired[Dict[str, Dict[str, Tuple[str, str]]] | None]

line_experiment_yptps instance-attribute

line_experiment_yptps: NotRequired[Dict[str, Dict[str, float]]]

line_includes instance-attribute

line_includes: NotRequired[List[str] | None]

line_override_xydata instance-attribute

line_override_xydata: NotRequired[Dict[str, Tuple[List[float], List[float]]]]

line_swap_xydata_to_ensure_increasing_xdata instance-attribute

line_swap_xydata_to_ensure_increasing_xdata: NotRequired[List[str]]

line_weights instance-attribute

line_weights: NotRequired[Dict[str, float]]

line_xptps instance-attribute

line_xptps: NotRequired[Dict[str, float]]

line_xys instance-attribute

line_xys: NotRequired[Dict[str, Tuple[str, str]] | None]

line_yptps instance-attribute

line_yptps: NotRequired[Dict[str, float]]

lognormal_parameters instance-attribute

lognormal_parameters: NotRequired[List[str | CalibrationKey]]

phase_steps instance-attribute

phase_steps: NotRequired[Dict[str, int]]

return_all_fitness instance-attribute

return_all_fitness: NotRequired[bool]

similarity_method instance-attribute

similarity_method: NotRequired[
    Literal["interpolate", "pcm", "area", "frechet-dist", "curve-length", "dtw"]
]

CalibrationOptionsProxy

Bases: HashableBaseModelIO

check_smoothness class-attribute instance-attribute

check_smoothness: bool = False

Whether to check if the data is smooth

data_get_kwargs class-attribute instance-attribute

data_get_kwargs: Dict[str, Any] = {}

Keyword arguments for the get method of the state variable exporter

error_fitness class-attribute instance-attribute

error_fitness: float = 10000000000.0

The error fitness.

error_raise class-attribute instance-attribute

error_raise: bool = False

Whether to raise an error if the fitness is not valid

experiment_excludes class-attribute instance-attribute

experiment_excludes: List[str] = []

Skipped experiments

experiment_get_kwargs class-attribute instance-attribute

experiment_get_kwargs: Dict[str, Any] = {}

Keyword arguments for the get method of experiment

experiment_includes class-attribute instance-attribute

experiment_includes: List[str] | None = None

Included experiments

experiment_options class-attribute instance-attribute

experiment_options: Dict[str, Dict[str, Any]] = {}

Override the options for each experiment

experiment_weights class-attribute instance-attribute

experiment_weights: Dict[str, float] = {}

Weights for the experiments

keys class-attribute instance-attribute

keys: List[str | CalibrationKey] = []

Optimization keys, a list of strings or tuples of strings (experiment name, material parameter name).

line_additions class-attribute instance-attribute

line_additions: Dict[str, Tuple[str, str]] = {}

Additional lines that can be expressions of the existing lines

line_clip_state_variables class-attribute instance-attribute

line_clip_state_variables: Dict[str, Tuple[float, float]] = {}

Clip state variables

line_clip_xydata class-attribute instance-attribute

line_clip_xydata: List[str] = []

Lines to clip the x and y data to the range of the experiment data

line_ensure_increasing_xdata class-attribute instance-attribute

line_ensure_increasing_xdata: List[str] = []

Ensure xdata is increasing by reconstructing the data with positive differences between every two points

line_excludes class-attribute instance-attribute

line_excludes: List[str] = []

Excluded lines

line_experiment_additions class-attribute instance-attribute

line_experiment_additions: Dict[str, Dict[str, Tuple[str, str]]] = {}

Additional lines that can be expressions of the existing lines for each experiment

line_experiment_clip_state_variables class-attribute instance-attribute

line_experiment_clip_state_variables: Dict[
    str, Dict[str, Tuple[float, float]]
] = {}

Clip state variables for each experiment

line_experiment_clip_xydata class-attribute instance-attribute

line_experiment_clip_xydata: Dict[str, List[str]] = {}

Lines to clip the x and y data to the range of the experiment data for each experiment

line_experiment_ensure_increasing_xdata class-attribute instance-attribute

line_experiment_ensure_increasing_xdata: Dict[str, List[str]] = {}

Ensure xdata is increasing by reconstructing the data with positive differences between every two points for each experiment

line_experiment_excludes class-attribute instance-attribute

line_experiment_excludes: Dict[str, List[str]] = {}

Excluded lines for each experiment

line_experiment_includes class-attribute instance-attribute

line_experiment_includes: Dict[str, List[str]] = {}

Included lines for each experiment

line_experiment_override_xydata class-attribute instance-attribute

line_experiment_override_xydata: Dict[
    str, Dict[str, Tuple[List[float], List[float]]]
] = {}

Override experimental data for each experiment

line_experiment_swap_xydata_to_ensure_increasing_xdata class-attribute instance-attribute

line_experiment_swap_xydata_to_ensure_increasing_xdata: Dict[str, List[str]] = (
    {}
)

Ensure xdata is increasing by swap xdata/ydata if ydata is increasing for each experiment

line_experiment_weights class-attribute instance-attribute

line_experiment_weights: Dict[str, Dict[str, float]] = {}

Weights for the lines for each experiment

line_experiment_xptps class-attribute instance-attribute

line_experiment_xptps: Dict[str, Dict[str, float]] = {}

Point-to-point y-axis distance for normalizing the similarity for each experiment

line_experiment_xys class-attribute instance-attribute

line_experiment_xys: Dict[str, Dict[str, Tuple[str, str]]] | None = None

Override default calibrated line x-y pairs for each experiment.

line_experiment_yptps class-attribute instance-attribute

line_experiment_yptps: Dict[str, Dict[str, float]] = {}

Point-to-point y-axis distance for normalizing the similarity for each experiment

line_includes class-attribute instance-attribute

line_includes: List[str] | None = None

Included lines

line_override_xydata class-attribute instance-attribute

line_override_xydata: Dict[str, Tuple[List[float], List[float]]] = {}

Override experimental data

line_swap_xydata_to_ensure_increasing_xdata class-attribute instance-attribute

line_swap_xydata_to_ensure_increasing_xdata: List[str] = []

Ensure xdata is increasing by swap xdata/ydata if ydata is increasing

line_weights class-attribute instance-attribute

line_weights: Dict[str, float] = {}

Weights for the lines

line_xptps class-attribute instance-attribute

line_xptps: Dict[str, float] = {}

Point-to-point x-axis distance for normalizing the similarity

line_xys class-attribute instance-attribute

line_xys: Dict[str, Tuple[str, str]] | None = None

Override default calibrated line x-y pairs.

line_yptps class-attribute instance-attribute

line_yptps: Dict[str, float] = {}

Point-to-point y-axis distance for normalizing the similarity

lognormal_parameters class-attribute instance-attribute

lognormal_parameters: List[str | CalibrationKey] = []

Parameters to be distributed in the lognormal space

phase_steps class-attribute instance-attribute

phase_steps: Dict[str, int] = {}

Override the number of steps for each load phase

return_all_fitness class-attribute instance-attribute

return_all_fitness: bool = False

Whether to return all fitness values or only the average fitness value.

similarity_method class-attribute instance-attribute

similarity_method: Literal[
    "interpolate", "pcm", "area", "frechet-dist", "curve-length", "dtw"
] = "interpolate"

The similarity method.

ElastoplasticCalibrationFitness

Bases: AbstractCalibrationFitness

io instance-attribute

io: ElastoplasticModelBaseIO

The elastoplastic model io.

MicromechanicalCalibrationFitness

Bases: AbstractCalibrationFitness

io instance-attribute

io: MicromechanicalModelBaseIO

The micromechanical model io.