io

ElastoplasticMaterialIO module-attribute

ElastoplasticMaterialIO = PythonElastoplasticMaterialIO

MicromechanicalMaterialIO module-attribute

MicromechanicalMaterialIO = PythonMicromechanicalMaterialIO

ContactLawIO

Bases: IO

material instance-attribute

material: MicromechanicalMaterialIO

material_ property

material_

The material object, only for type hinting

name instance-attribute

name: str

options instance-attribute

options: OptionsIO

makeObject

makeObject()

CppElastoplasticMaterialIO

Bases: CppMaterialIO

makeObject

makeObject()

CppMaterialIO

Bases: MaterialBaseIO

props class-attribute instance-attribute

props: Dict[str, float] = {}

setParameters

setParameters(**kwargs)

CppMicromechanicalMaterialIO

Bases: CppMaterialIO

fabrics instance-attribute

fabrics: Dict[str, FabricTensorIO]

makeObject

makeObject()

DebugVariableIO

Bases: IO

debug instance-attribute

debug: bool

enables instance-attribute

enables: Dict[str, bool]

makeAttribute classmethod

makeAttribute(key: str, value)

makeObject

makeObject()

ElastoplasticModelBaseIO

Bases: ModelBaseIO

fabric instance-attribute

fabric: FabricTensorIO

material instance-attribute

material: ElastoplasticMaterialIO

plasticMethod class-attribute instance-attribute

plasticMethod: str = 'CPA'

makeObject

makeObject()

ElastoplasticModelIO

Bases: IO

model instance-attribute

model: ElastoplasticModelBaseIO

no_stop instance-attribute

no_stop: bool

makeObject

makeObject()

FabricTensorIO

Bases: IO

coefs instance-attribute

coefs: Dict[str, float]

evolution instance-attribute

evolution: AvailableFabricEvolutionTypes

type instance-attribute

type: AvailableFabricTypes

makeAttribute classmethod

makeAttribute(key: str, value)

makeObject

makeObject()

IO

Bases: HashableBaseModelIO, ABC

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, **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()

Make the original python object

toObject

toObject(parent=None, name: str | None = None, **kwargs)

Revert the object to its original state

PARAMETER	DESCRIPTION
parent	The parent object for getting existing object instead of creating a new one 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

type instance-attribute

type: str

makeObject

makeObject()

LoadIO

Bases: IO

phases instance-attribute

phases: List[LoadPhaseIO]

makeAttribute classmethod

makeAttribute(key: str, value)

makeObject

makeObject()

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()

MaterialBaseIO

Bases: IO, ABC

setParameters abstractmethod

setParameters(**kwargs)

Set material properties

MicromechanicalModelBaseIO

Bases: ModelBaseIO

contact instance-attribute

contact: ContactLawIO

integration instance-attribute

integration: IntegrationIO

makeObject

makeObject()

MicromechanicalModelIO

Bases: IO

model instance-attribute

model: MicromechanicalModelBaseIO

no_stop instance-attribute

no_stop: bool

makeObject

makeObject()

ModelBaseIO

Bases: IO

debugVariable instance-attribute

debugVariable: DebugVariableIO

load instance-attribute

load: LoadIO

name instance-attribute

name: str

options instance-attribute

options: OptionsIO

OptionsIO

Bases: IO, OptionsProxy

makeObject

makeObject()

PythonElastoplasticMaterialIO

Bases: PythonMaterialIO

Ad instance-attribute

Ad: float

E instance-attribute

E: float

G instance-attribute

G: float

K instance-attribute

K: float

Lambda instance-attribute

Lambda: float

M instance-attribute

M: float

c instance-attribute

c: float

e0 instance-attribute

e0: float

eref instance-attribute

eref: float

kp instance-attribute

kp: float

lame instance-attribute

lame: float

nd instance-attribute

nd: float

np instance-attribute

np: float

nu instance-attribute

nu: float

phi instance-attribute

phi: float

pref instance-attribute

pref: float

xi instance-attribute

xi: float

makeObject

makeObject()

PythonMaterialIO

Bases: MaterialBaseIO

props instance-attribute

props: Dict[str, float]

makeAttribute classmethod

makeAttribute(key: str, value)

setParameters

setParameters(**kwargs)

PythonMicromechanicalMaterialIO

Bases: PythonMaterialIO

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

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

fabrics instance-attribute

fabrics: Dict[str, FabricTensorIO]

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

makeObject

makeObject()