io

MaterialIO module-attribute

MaterialIO: Type[PythonMaterialIO | CppMaterialIO] = (
    PythonMaterialIO if is_python_backend else CppMaterialIO
)

MaterialIOType module-attribute

MaterialIOType: Type[PythonMaterialIO | CppMaterialIO] = Union[
    PythonMaterialIO, CppMaterialIO
]

AbstractMaterialIO

Bases: IO

fabrics instance-attribute

fabrics: Dict[str, FabricTensorIO]

makeAttribute classmethod

makeAttribute(key: str, value)

makeObject

makeObject() -> 'Material'

setParameters abstractmethod

setParameters(**kwargs)

Set material properties

ContactLawIO

Bases: IO

material instance-attribute

material: MaterialIO

material_ property

material_: MaterialIOType

The material object, only for type hinting

name instance-attribute

name: str

options instance-attribute

options: OptionsIO

makeObject

makeObject() -> 'ContactLawBase'

CppMaterialIO

Bases: AbstractMaterialIO

props class-attribute instance-attribute

props: Dict[str, float] = {}

setParameters

setParameters(**kwargs)

DebugVariableIO

Bases: IO

debug instance-attribute

debug: bool

enables instance-attribute

enables: Dict[str, bool]

makeAttribute classmethod

makeAttribute(key: str, value: Dict[str, bool])

makeObject

makeObject()

FabricTensorIO

Bases: IO

coefs instance-attribute

coefs: Dict[str, float]

evolution instance-attribute

evolution: str

type instance-attribute

type: str

makeAttribute classmethod

makeAttribute(key: str, value)

makeObject

makeObject() -> Union['FabricTensor']

IO

Bases: HashableBaseModelIO

Base class for input/output objects. The IO objects are loaded from the attributes of the original python object. To restore the IO object to the original python object, first create the original object with the makeObject method, then set the attributes to the original object. If the attribute is an IO object, the toObject method will be called recursively. If an attribute should be pre-processed before setting it to the original object, redefine the makeAttribute method in the subclass. Lists are converted into numpy arrays by default, if not, redefine the makeAttribute method in the subclass.

reverted class-attribute instance-attribute

reverted = toObject

fromObject classmethod

fromObject(obj: Union['AnyType', 'Model'], **kwargs) -> Self

Load the model from an object.

makeAttribute classmethod

makeAttribute(key: str, value)

Prepare the attribute to be set to the original python object

makeObject abstractmethod

makeObject() -> Union['AnyType', 'Model', Any]

Make the original python object

toObject

toObject(
    parent: Union["AnyType", "Model", None] = None,
    name: str | None = None,
    **kwargs
) -> Union["AnyType", "Model", Any]

Revert the object to its original state

PARAMETER	DESCRIPTION
parent	The parent object for getting existing object instead of creating a new one TYPE: AnyType DEFAULT: None
name	The name of the attribute in the parent object TYPE: str DEFAULT: None
kwargs	Keyword arguments to override the attributes DEFAULT: {}

RETURNS	DESCRIPTION
The original object

IntegrationIO

Bases: IO

fabric instance-attribute

fabric: FabricTensorIO

gauss_weight instance-attribute

gauss_weight: List[float]

n instance-attribute

n: List[List[float]]

npv instance-attribute

npv: float

radius instance-attribute

radius: float

makeObject

makeObject() -> 'Integration'

LoadIO

Bases: IO

phases instance-attribute

phases: List[LoadPhaseIO]

makeAttribute classmethod

makeAttribute(key: str, value)

makeObject

makeObject() -> 'Load'

LoadPhaseIO

Bases: IO

b instance-attribute

b: float

control instance-attribute

control: List[float]

final instance-attribute

final: List[float]

initial instance-attribute

initial: List[float]

steps instance-attribute

steps: int

total instance-attribute

total: List[float]

makeObject

makeObject() -> 'LoadPhase'

MicromechanicalModelIO

Bases: IO

contact instance-attribute

contact: ContactLawIO

debugVariable instance-attribute

debugVariable: DebugVariableIO

integration instance-attribute

integration: IntegrationIO

load instance-attribute

load: LoadIO

name instance-attribute

name: str

options instance-attribute

options: OptionsIO

makeObject

makeObject() -> 'MicromechanicalBase'

ModelIO

Bases: IO

model instance-attribute

model: MicromechanicalModelIO

no_stop instance-attribute

no_stop: bool

makeObject

makeObject() -> 'Model'

OptionsIO

Bases: IO

best_fit_strain_averaging instance-attribute

best_fit_strain_averaging: bool

cache instance-attribute

cache: bool

cache_precision instance-attribute

cache_precision: int

contact_check_convergence instance-attribute

contact_check_convergence: bool

contact_check_plastic_multiplier instance-attribute

contact_check_plastic_multiplier: bool

contact_ensure_force_state_on_yield_surface instance-attribute

contact_ensure_force_state_on_yield_surface: bool

contact_friction_angle_combined instance-attribute

contact_friction_angle_combined: bool

contact_friction_angle_weight_mises instance-attribute

contact_friction_angle_weight_mises: float

contact_friction_angle_weight_mohr_coulomb instance-attribute

contact_friction_angle_weight_mohr_coulomb: float

contact_friction_angle_weight_smp instance-attribute

contact_friction_angle_weight_smp: float

contact_friction_angle_weight_tresca instance-attribute

contact_friction_angle_weight_tresca: float

contact_linear_critical_state_line instance-attribute

contact_linear_critical_state_line: bool

contact_max_increment instance-attribute

contact_max_increment: float

contact_max_iterations instance-attribute

contact_max_iterations: int

contact_min_normal_force instance-attribute

contact_min_normal_force: float

contact_plastic_method_multiplier instance-attribute

contact_plastic_method_multiplier: float

contact_sanisand_constant_hardening_parameter instance-attribute

contact_sanisand_constant_hardening_parameter: bool

contact_sanisand_maintain_yield_surface instance-attribute

contact_sanisand_maintain_yield_surface: bool

contact_tolerance instance-attribute

contact_tolerance: float

debug instance-attribute

debug: bool

disp_steps instance-attribute

disp_steps: int

ignore_distractions instance-attribute

ignore_distractions: bool

ignore_fabric_evolution_for_isotropic_loading instance-attribute

ignore_fabric_evolution_for_isotropic_loading: bool

ignore_fabric_rotations_for_isotropic_loading instance-attribute

ignore_fabric_rotations_for_isotropic_loading: bool

increment_plastic_displacement instance-attribute

increment_plastic_displacement: bool

integration_absolute_tolerance instance-attribute

integration_absolute_tolerance: float

integration_check_absolute_convergence instance-attribute

integration_check_absolute_convergence: bool

integration_check_convergence instance-attribute

integration_check_convergence: bool

integration_loading_ratio instance-attribute

integration_loading_ratio: float

integration_max_iterations instance-attribute

integration_max_iterations: int

integration_max_substepping_ratio instance-attribute

integration_max_substepping_ratio: float

integration_min_substepping_ratio instance-attribute

integration_min_substepping_ratio: float

integration_relative_tolerance instance-attribute

integration_relative_tolerance: float

integration_substepping_relative_to_increment instance-attribute

integration_substepping_relative_to_increment: bool

kinematic_hypothesis instance-attribute

kinematic_hypothesis: bool

mixed_load_absolute_tolerance instance-attribute

mixed_load_absolute_tolerance: float

mixed_load_check_absolute_convergence instance-attribute

mixed_load_check_absolute_convergence: bool

mixed_load_check_convergence instance-attribute

mixed_load_check_convergence: bool

mixed_load_check_strain_convergence instance-attribute

mixed_load_check_strain_convergence: bool

mixed_load_max_iterations instance-attribute

mixed_load_max_iterations: int

mixed_load_max_larger_steps instance-attribute

mixed_load_max_larger_steps: int

mixed_load_relative_tolerance instance-attribute

mixed_load_relative_tolerance: float

precise_incremental_volumetric_strain instance-attribute

precise_incremental_volumetric_strain: bool

run_contact_integration_steps instance-attribute

run_contact_integration_steps: int

run_mixed_load_steps instance-attribute

run_mixed_load_steps: int

run_steps instance-attribute

run_steps: int

separate_mean_deviatoric_stress_strain instance-attribute

separate_mean_deviatoric_stress_strain: bool

update_fabric_coefs instance-attribute

update_fabric_coefs: bool

update_npv instance-attribute

update_npv: bool

update_void_ratio_from_after_isotropic_loading_to_before instance-attribute

update_void_ratio_from_after_isotropic_loading_to_before: bool

use_isotropic_fabric_tensor_in_strain_averaging instance-attribute

use_isotropic_fabric_tensor_in_strain_averaging: bool

use_isotropic_fabric_tensor_in_stress_localization instance-attribute

use_isotropic_fabric_tensor_in_stress_localization: bool

use_plastic_strain_in_fabric_evolution instance-attribute

use_plastic_strain_in_fabric_evolution: bool

verbose instance-attribute

verbose: bool

makeObject

makeObject() -> 'Options'

PythonMaterialIO

Bases: AbstractMaterialIO

Ad instance-attribute

Ad: float

Lambda instance-attribute

Lambda: float

R instance-attribute

R: float

V instance-attribute

V: float

X instance-attribute

X: float

b instance-attribute

b: float

c instance-attribute

c: float

ch instance-attribute

ch: float

chi0 instance-attribute

chi0: float

cohesion instance-attribute

cohesion: float

custom instance-attribute

custom: Dict[str, float]

e0 instance-attribute

e0: float

ec0 instance-attribute

ec0: float

emax instance-attribute

emax: float

emin instance-attribute

emin: float

eref instance-attribute

eref: float

eref0 instance-attribute

eref0: float

erefu instance-attribute

erefu: float

fb0 instance-attribute

fb0: float

fc0 instance-attribute

fc0: float

fnr instance-attribute

fnr: float

fref instance-attribute

fref: float

h0 instance-attribute

h0: float

hp instance-attribute

hp: float

kappa instance-attribute

kappa: float

kn0 instance-attribute

kn0: float

kp instance-attribute

kp: float

kpr instance-attribute

kpr: float

krr instance-attribute

krr: float

kt0 instance-attribute

kt0: float

m instance-attribute

m: float

n instance-attribute

n: float

nd instance-attribute

nd: float

ne instance-attribute

ne: float

ng instance-attribute

ng: float

np instance-attribute

np: float

nw instance-attribute

nw: float

phi instance-attribute

phi: float

pref instance-attribute

pref: float

rho instance-attribute

rho: float

rhoc instance-attribute

rhoc: float

theta instance-attribute

theta: float

vf instance-attribute

vf: float

vi instance-attribute

vi: float

xi instance-attribute

xi: float

xib instance-attribute

xib: float

xic instance-attribute

xic: float

makeAttribute classmethod

makeAttribute(key: str, value)

setParameters

setParameters(**kwargs)