LMGC90

https://lmgc90.pages-git-xen.lmgc.univ-montp2.fr/lmgc90_dev/
Admin
LMGC90 is an open source software for modeling large collections of interacting objects with support...
Tokens:422,242
Snippets:2,592
Trust Score:9.9
Update:9 months ago
Show doc for...
Tokens:
Raw
### Example Usage and Plotting (Python)

Source: https://lmgc90.pages-git-xen.lmgc.univ-montp2.fr/lmgc90_dev/_modules/pylmgc90/pre/build_avatar/tools/granulometry

Demonstrates the usage of various granulometry generation functions and includes an example of plotting the generated distributions using matplotlib. It requires numpy and optionally matplotlib for visualization.

```python
if __name__ == "__main__":
  import time

  nb = 100000
  ra = 2.
  rb = 20.
  pm = 0.25
  fname = 'granulo.txt'
  V  = 1.e6
  x  = 1.
  a  = b = 1.

  t1 = time.time()
  rand = granulo_Random(nb,ra,rb)
  print(time.time()-t1)
    
  t1 = time.time()
  unif = granulo_Uniform(nb,ra,rb)
  print(time.time()-t1)
  
  t1 = time.time()
  twos = granulo_TwoSizesNumber(nb,ra,rb,pm)
  print(time.time()-t1)

  t1 = time.time()
  twov = granulo_TwoSizesVolume(nb,ra,rb,pm)
  print(time.time()-t1)

  numpy.savetxt(fname,twov)
  t1 = time.time()
  read = granulo_ReadFromFile(fname)
  print(time.time()-t1)
  assert numpy.all(twov==read)

  t1 = time.time()
  ra=4.e-3; rb=1.e-2; V=1.e-3; a=b=1;nb_t=10
  beta = granulo_BetaDistribution(ra,rb,nb_t,V,a,b)
  print(time.time()-t1)
  
  try:
    import matplotlib.pyplot as plt
  
    plt.figure(1)
  
    dist = [rand, unif, twos, twov, read]
    if beta is not None :
      dist.append(beta)

    for i, d in enumerate(dist):
      plt.subplot(231+i)
      count, bins, ignored = plt.hist(d, 20)
  
    plt.show()
  except:
    raise
```

--------------------------------

### Simulation Setup and Configuration

Source: https://lmgc90.pages-git-xen.lmgc.univ-montp2.fr/lmgc90_dev/chipy_macro

Functions for setting up the simulation environment, including dimensions, boundary conditions, and interaction parameters.

```APIDOC
## SetDomainBoundary

### Description
Set active domain boundary for rigid bodies.

### Method
`SetDomainBoundary`

### Endpoint
`/websites/lmgc90_pages-git-xen_lmgc_univ-montp2_fr_lmgc90_dev/pylmgc90/chipy/macro/SetDomainBoundary`

### Parameters
#### Path Parameters
None

#### Query Parameters
* **_Xmin** (float) - Optional - Minimum X boundary.
* **_Xmax** (float) - Optional - Maximum X boundary.
* **_Ymin** (float) - Optional - Minimum Y boundary.
* **_Ymax** (float) - Optional - Maximum Y boundary.
* **_Zmin** (float) - Optional - Minimum Z boundary.
* **_Zmax** (float) - Optional - Maximum Z boundary.

### Request Example
```json
{
  "_Xmin": 0.0,
  "_Xmax": 1.0,
  "_Ymin": 0.0,
  "_Ymax": 1.0,
  "_Zmin": 0.0,
  "_Zmax": 1.0
}
```

### Response
#### Success Response (200)
None

## SetNumberInteractionByContact

### Description
Experimental: set the number of interaction by contact. Available only for sphere/sphere and cylinder/cylinder contacts.

### Method
`SetNumberInteractionByContact`

### Endpoint
`/websites/lmgc90_pages-git-xen_lmgc_univ-montp2_fr_lmgc90_dev/pylmgc90/chipy/macro/SetNumberInteractionByContact`

### Parameters
#### Path Parameters
None

#### Query Parameters
* **_nb_** (int) - Required - The number of interactions per contact.

### Request Example
```json
{
  "_nb_": 100
}
```

### Response
#### Success Response (200)
None

## SetPeriodicCondition

### Description
Set periodic conditions for rigid bodies.

### Method
`SetPeriodicCondition`

### Endpoint
`/websites/lmgc90_pages-git-xen_lmgc_univ-montp2_fr_lmgc90_dev/pylmgc90/chipy/macro/SetPeriodicCondition`

### Parameters
#### Path Parameters
None

#### Query Parameters
* **_xperiod** (float) - Optional - Periodicity in the x-direction.
* **_yperiod** (float) - Optional - Periodicity in the y-direction.

### Request Example
```json
{
  "_xperiod": 10.0,
  "_yperiod": 10.0
}
```

### Response
#### Success Response (200)
None

```

--------------------------------

### Initialize Post-Processing Files

Source: https://lmgc90.pages-git-xen.lmgc.univ-montp2.fr/lmgc90_dev/chipy_macro

Initializes the writing of files for post-processing. It takes an optional 'restart' parameter to specify the starting index for writing.

```python
pylmgc90.chipy.macro.OpenPostproFiles(_restart =0_)
```

--------------------------------

### Pre-simulation and State Management

Source: https://lmgc90.pages-git-xen.lmgc.univ-montp2.fr/lmgc90_dev/genindex

Functions related to pre-simulation setup, including reading initial states, mesh data, and managing avatars.

```APIDOC
## Pre-simulation and State Management

### Description
Functions for reading initial simulation configurations, mesh data, and managing avatars before running the main simulation loop.

### Functions
- `ReadIni()`
- `ReadIniDof()`
- `ReadIniGPV()`
- `ReadIniMpValues()`
- `ReadIniVlocRloc()`
- `readMesh()`
- `readState()`
- `removeFreeNodes()`
- `renumber()`
- `rotate()`

### Module
pylmgc90.chipy.macro, pylmgc90.pre
```

--------------------------------

### Get Number of Nodes in MAILx

Source: https://lmgc90.pages-git-xen.lmgc.univ-montp2.fr/lmgc90_dev/chipy_lmgc90

Gets the number of nodes for a given MAILx body. It requires the body ID and returns the total count of nodes associated with that body.

```python
nb_nodes = MAILx_GetNbNodes(ibdyty)

```

--------------------------------

### Initialize Visualization Files

Source: https://lmgc90.pages-git-xen.lmgc.univ-montp2.fr/lmgc90_dev/chipy_macro

Sets up the writing of visualization files. It allows configuration of restart files, mechanical and thermal fields to display, and the level of detail for face-to-face data writing. Parameters include 'restart', 'mecagp_field', 'thergp_field', 'write_f2f', and 'write_parameters'.

```python
pylmgc90.chipy.macro.OpenDisplayFiles(_restart =1_, _mecagp_field =None_, _thergp_field =None_, _write_f2f =0_, _write_parameters =True_)
```

--------------------------------

### Get Number of Cells in MAILx

Source: https://lmgc90.pages-git-xen.lmgc.univ-montp2.fr/lmgc90_dev/chipy_lmgc90

Gets the number of cells for a given MAILx body. It requires the body ID as input and returns the total count of cells associated with that body.

```python
nb_cell = GetNbCell(IdBody)

```

--------------------------------

### Install gmshutils Python Module

Source: https://lmgc90.pages-git-xen.lmgc.univ-montp2.fr/lmgc90_dev/_sources/gmsh_index.rst

Installs or upgrades the gmsh Python module using pip. This module is required to use the GMSH functionalities within pylmgc90.

```bash
pip install --upgrade gmsh
```

--------------------------------

### ExSolver

Source: https://lmgc90.pages-git-xen.lmgc.univ-montp2.fr/lmgc90_dev/chipy_macro

Runs the Non-linear Gauss Seidel contact solver with specified parameters for convergence and iteration control.

```APIDOC
## ExSolver

### Description
Runs the Non-linear Gauss Seidel contact solver with specified parameters for convergence and iteration control.

### Method
`ExSolver(_stype_ , _norm_ , _conv_ , _relax_ , _gsit1_ , _gsit2_)`

### Endpoint
N/A (Python function)

### Parameters
- **stype** (string) - Type of solver ('Exchange Local Global' or 'Stored_Delassus_Loops').
- **norm** (string) - Type of norm ('Quad', 'QM/16', 'Maxm').
- **conv** (float) - Convergence tolerance demanded.
- **relax** (float) - Relaxation parameter.
- **gsit1** (int) - Maximum number of convergence checks before stopping.
- **gsit2** (int) - Number of iterations of nlgs before checking convergence.

### Request Example
```python
pylmgc90.chipy.macro.ExSolver('Exchange Local Global', 'Quad', 1e-06, 1.0, 100, 50)
```

### Response
#### Success Response
N/A (Python function execution)

#### Response Example
N/A
```

--------------------------------

### Initialize LMGC90

Source: https://lmgc90.pages-git-xen.lmgc.univ-montp2.fr/lmgc90_dev/chipy_macro

Initializes the LMGC90 simulation environment and timers.

```APIDOC
## Initialize LMGC90

### Description
Initializes LMGC90 and its timers. The `timer_GetNewTimer(xxx)` function must be called after this function.

### Method
`Initialize()`

### Endpoint
N/A (Python function)

### Parameters
None

### Request Example
```python
pylmgc90.chipy.macro.Initialize()
timer_id = timer_GetNewTimer('main_loop')
```

### Response
#### Success Response
N/A (Python function execution)

#### Response Example
N/A
```

--------------------------------

### Initialize Chipy and Set Up Simulation Parameters

Source: https://lmgc90.pages-git-xen.lmgc.univ-montp2.fr/lmgc90_dev/_sources/chipy_common.rst

This snippet demonstrates the essential steps to initialize the chipy module, set simulation parameters like space dimension, time stepping, and solver configurations, and manage output files. It covers importing the library, initializing core components, defining variables, and setting up logging and display.

```python
from pylmgc90 import chipy

# Initializing 
chipy.Initialize()

# checking/creating mandatory subfolders
chipy.checkDirectories()

# space dimension
dim = 2 

# modeling hypothesis ( 1 = plain strain, 2 = plain stress, 3 = axi-symmetry)
mhyp = 1

# time evolution parameters
dt = 1e-3
nb_steps = 100

# theta integrator parameter
theta = 0.5

# deformable True or False
deformable = False

# interaction parameters
Rloc_tol = 5.e-2

# nlgs parameters
tol = 1e-4
relax = 1.0  
norm = 'Quad '
gs_it1 = 50 
gs_it2 = 10
solver_type='Stored_Delassus_Loops         '

# write parameter
freq_write   = 10

# display parameters
freq_display = 10

# Set space dimension
chipy.SetDimension(dim,mhyp)
chipy.utilities_logMes('INIT TIME STEPPING')
chipy.TimeEvolution_SetTimeStep(dt)
chipy.Integrator_InitTheta(theta)
chipy.utilities_logMes('READ DATBOX')
chipy.ReadDatbox(deformable)

chipy.utilities_logMes('DISPLAY & WRITE') 
chipy.OpenDisplayFiles()
chipy.OpenPostproFiles()

# if HDF5 is available
chipy.InitHDF5('lmgc90.h5')

# ... simulation part ...

chipy.CloseDisplayFiles()
chipy.ClosePostproFiles()

# this is the end
chipy.Finalize()
```

--------------------------------

### poroMAILx_GetTherVectorFieldRank - Get Thermal Vector Field Rank

Source: https://lmgc90.pages-git-xen.lmgc.univ-montp2.fr/lmgc90_dev/chipy_lmgc90

Gets the rank of a thermal vector field for a given element of a body, identified by its name. Used for accessing specific thermal vector data.

```APIDOC
## GET /lmgc90/poroMAILx_GetTherVectorFieldRank

### Description
Gets the rank of a thermal vector field for an element of a body, identified by its name.

### Method
GET

### Endpoint
/lmgc90/poroMAILx_GetTherVectorFieldRank

### Parameters
#### Query Parameters
- **ibdyty** (integer) - Required - The ID of the concerned body.
- **iblmty** (integer) - Required - The ID of the concerned element.
- **name** (string) - Required - The name of the desired vector field.

### Response
#### Success Response (200)
- **field_rank** (integer) - The rank of the corresponding vector field.

#### Response Example
```json
{
  "field_rank": 4
}
```
```

--------------------------------

### LMGC90 Postpro Commands in Python

Source: https://lmgc90.pages-git-xen.lmgc.univ-montp2.fr/lmgc90_dev/pre_post

Demonstrates how to create and add various post-processing commands for LMGC90 simulations using Python. This includes setting up mechanical sets, tracking evolutions of displacement and forces for deformable and rigid bodies, and analyzing doublet torques. The commands are then written to a file.

```python
post = pre.postpro_commands()
#
# creating a deformable set
#
mecax_set = [(body_deformable_brick, "coin")]
post.addCommand(pre.postpro_command(name='NEW MECAx SETS', mecax_sets=[mecax_set]))
#
# following mean displacement and force of deformable sets
#
post.addCommand(pre.postpro_command(name='Dep EVOLUTION', step=1))
post.addCommand(pre.postpro_command(name='Fint EVOLUTION', step=1))
#
# following displacement and force on a rigid object :
#
post.addCommand(pre.postpro_command(name='BODY TRACKING', step=1, rigid_set=[body_rigid_brick]))
post.addCommand(pre.postpro_command(name='TORQUE EVOLUTION', step=1, rigid_set=[body_rigid_brick]))
#
post.addCommand(pre.postpro_command(name='DOUBLET TORQUE EVOLUTION', step=1,doublets=[(up,down)]) )
#
post.addCommand(pre.postpro_command(name='SOLVER INFORMATIONS', step=1))
#
pre.writePostpro(commands=post, parts=bodies, path='DATBOX/')

```

--------------------------------

### poroMAILx_GetTherScalarFieldRank - Get Thermal Scalar Field Rank

Source: https://lmgc90.pages-git-xen.lmgc.univ-montp2.fr/lmgc90_dev/chipy_lmgc90

Gets the rank of a thermal scalar field for a given element of a body, identified by its name. Used for accessing specific thermal scalar data.

```APIDOC
## GET /lmgc90/poroMAILx_GetTherScalarFieldRank

### Description
Gets the rank of a thermal scalar field for an element of a body, identified by its name.

### Method
GET

### Endpoint
/lmgc90/poroMAILx_GetTherScalarFieldRank

### Parameters
#### Query Parameters
- **ibdyty** (integer) - Required - The ID of the concerned body.
- **iblmty** (integer) - Required - The ID of the concerned element.
- **name** (string) - Required - The name of the desired scalar field.

### Response
#### Success Response (200)
- **field_rank** (integer) - The rank of the corresponding scalar field.

#### Response Example
```json
{
  "field_rank": 3
}
```
```

--------------------------------

### poroMAILx_GetMecaVectorFieldRank - Get Mechanical Vector Field Rank

Source: https://lmgc90.pages-git-xen.lmgc.univ-montp2.fr/lmgc90_dev/chipy_lmgc90

Gets the rank of a mechanical vector field for a given element of a body, identified by its name. Used to access specific vector field data.

```APIDOC
## GET /lmgc90/poroMAILx_GetMecaVectorFieldRank

### Description
Gets the rank of a mechanical vector field for an element of a body, identified by its name.

### Method
GET

### Endpoint
/lmgc90/poroMAILx_GetMecaVectorFieldRank

### Parameters
#### Query Parameters
- **ibdyty** (integer) - Required - The ID of the concerned body.
- **iblmty** (integer) - Required - The ID of the concerned element.
- **name** (string) - Required - The name of the desired vector field.

### Response
#### Success Response (200)
- **field_rank** (integer) - The rank of the corresponding vector field.

#### Response Example
```json
{
  "field_rank": 2
}
```
```

--------------------------------

### Initialize HDF5 Output

Source: https://lmgc90.pages-git-xen.lmgc.univ-montp2.fr/lmgc90_dev/chipy_macro

Initializes an HDF5 output file for saving simulation data. If not compiled with HDF5 support or no filename is provided, it defaults to ASCII output.

```APIDOC
## Initialize HDF5 Output

### Description
Initializes an HDF5 output file. If no filename is given or HDF5 has not been used during compilation, this function is ignored and subsequent calls to `WriteOut` will write ASCII files in the OUTBOX directory.

### Method
`InitHDF5(_filename =''_)`

### Endpoint
N/A (Python function)

### Parameters
- **filename** (str, optional) - The name of the HDF5 file to create. Defaults to an empty string.

### Request Example
```python
pylmgc90.chipy.macro.InitHDF5('simulation_data.h5')
# Or to rely on default ASCII output:
pylmgc90.chipy.macro.InitHDF5()
```

### Response
#### Success Response
N/A (Python function execution)

#### Response Example
N/A
```

--------------------------------

### Building Evolution File with writeEvolution() in Python

Source: https://lmgc90.pages-git-xen.lmgc.univ-montp2.fr/lmgc90_dev/pre_miscellaneous

Demonstrates how to create an evolution file for applying non-trivial loads using the `writeEvolution()` function. This function takes a callable for load calculation, a set of time instants, and an output path and name. It's useful for defining time-dependent forces or other loads.

```python
import numpy

t0=0.5
t1 =1.
f = 100.

def imposedForce(t):
   # 0 until t0
   if t <= t0:
      return 0.
   # linear growing between [t0, t1]
   elif t > t0 and t <= t1:
      return -f*(t-t0)/(t1-t0)
   # constant value afterward
   else:
      return -f

pre.writeEvolution(f=imposedForce, instants=numpy.linspace(0., 2*t1, 1000) ,path='DATBOX/', name='force.dat')
```

--------------------------------

### poroMAILx_GetMecaScalarFieldRank - Get Mechanical Scalar Field Rank

Source: https://lmgc90.pages-git-xen.lmgc.univ-montp2.fr/lmgc90_dev/chipy_lmgc90

Gets the rank of a mechanical scalar field for a given element of a body, identified by its name. Used to access specific scalar field data.

```APIDOC
## GET /lmgc90/poroMAILx_GetMecaScalarFieldRank

### Description
Gets the rank of a mechanical scalar field for an element of a body, identified by its name.

### Method
GET

### Endpoint
/lmgc90/poroMAILx_GetMecaScalarFieldRank

### Parameters
#### Query Parameters
- **ibdyty** (integer) - Required - The ID of the concerned body.
- **iblmty** (integer) - Required - The ID of the concerned element.
- **name** (string) - Required - The name of the desired scalar field.

### Response
#### Success Response (200)
- **field_rank** (integer) - The rank of the corresponding scalar field.

#### Response Example
```json
{
  "field_rank": 1
}
```
```

--------------------------------

### Get Rigid Body Inertia Frame (Python)

Source: https://lmgc90.pages-git-xen.lmgc.univ-montp2.fr/lmgc90_dev/chipy_lmgc90

Retrieves the inertia frame matrix for a rigid body. The 'datatype' parameter specifies whether to get the beginning ('RFbeg'), current ('RF___'), or translational ('RFTT_') frame. It returns a float matrix.

```python
mat = mecaMAILx_GetRigidFrame(datatype, ibdyty)
```

--------------------------------

### Get Pointer to Normal in Detection Configuration - POLYR_GetPtrNormalTT

Source: https://lmgc90.pages-git-xen.lmgc.univ-montp2.fr/lmgc90_dev/chipy_lmgc90

Gets a pointer to the normal vector of a POLYR in a detection configuration. Caution is advised as it points to the internal data structure, and moving the POLYR might invalidate the pointer. It returns the coordinates of the vertices of the normal.

```python
normal = POLYR_GetPtrNormalTT(itacty)
```

--------------------------------

### Build 2D Fine Wall with Overlapping Contactors (Python)

Source: https://lmgc90.pages-git-xen.lmgc.univ-montp2.fr/lmgc90_dev/pre_classes

Creates a 2D wall characterized by overlapping contactors, resulting in reduced roughness. This is achieved by generating a cluster of disks or polygons with specific overlapping configurations. Parameters include geometric and material properties.

```python
pylmgc90.pre.fineWall(center, l, r, model, material, theta=0.0, color='WALLx', nb_vertex=0, number=None)
```

--------------------------------

### multiMAILx_GetNb

Source: https://lmgc90.pages-git-xen.lmgc.univ-montp2.fr/lmgc90_dev/chipy_lmgc90

Gets the total number of multiMAILx instances.

```APIDOC
## GET /multiMAILx/GetNb

### Description
Gets the total number of multiMAILx instances.

### Method
GET

### Endpoint
/multiMAILx/GetNb

### Response
#### Success Response (200)
- **nb_multiMAILx** (integer) - The number of multiMAILx instances.

#### Response Example
```json
{
  "nb_multiMAILx": 10
}
```
```

--------------------------------

### Managing CZM (Cohesive Zone Model)

Source: https://lmgc90.pages-git-xen.lmgc.univ-montp2.fr/lmgc90_dev/_sources/chipy_tact.rst

Function to set up CZM with initial friction parameters.

```APIDOC
## Managing CZM (Cohesive Zone Model)

### Description
Function to set up CZM with initial friction parameters.

### Method
Function call

### Endpoint
N/A (Python module function)

### Parameters
#### Path Parameters
- **pow** (int) - Optional - An integer parameter related to the power for initial friction.

### Request Example
```python
tact_behav_SetCZMwithInitialFriction(2)
```

### Response
N/A

#### Success Response (200)
N/A

#### Response Example
N/A
```

--------------------------------

### multiMAILx_GetNbNodes

Source: https://lmgc90.pages-git-xen.lmgc.univ-montp2.fr/lmgc90_dev/chipy_lmgc90

Gets the number of nodes for a specific multiMAILx instance.

```APIDOC
## GET /multiMAILx/GetNbNodes

### Description
Gets the number of nodes for a specific multiMAILx instance.

### Method
GET

### Endpoint
/multiMAILx/GetNbNodes

### Parameters
#### Path Parameters
- **ivalue** (integer) - Required - The ID of the multiMAILx instance.

### Response
#### Success Response (200)
- **nb_nodes** (integer) - The number of nodes in the multiMAILx instance.

#### Response Example
```json
{
  "nb_nodes": 500
}
```
```

--------------------------------

### Macro and Chipy Functions

Source: https://lmgc90.pages-git-xen.lmgc.univ-montp2.fr/lmgc90_dev/genindex

Details on various macro and chipy functions for setting up simulations, including contact parameters, dimensions, boundary conditions, and periodic conditions.

```APIDOC
## Macro and Chipy Functions

### Description
This section covers a range of functions for configuring simulation parameters, such as contact detection, domain boundaries, and periodic conditions.

### Methods

- **SelectProxTactors()** (in module pylmgc90.chipy.macro)
  - Description: Selects proximity tactors.

- **SetContactRadius()** (in module pylmgc90.chipy.macro)
  - Description: Sets the contact radius.

- **SetDimension()** (in module pylmgc90.chipy.macro)
  - Description: Sets the simulation dimension.

- **SetDomainBoundary()** (in module pylmgc90.chipy.macro)
  - Description: Sets the domain boundary conditions.

- **setInternalArray()** (in module pylmgc90.chipy.macro)
  - Description: Sets an internal array.

- **SetNumberInteractionByContact()** (in module pylmgc90.chipy.macro)
  - Description: Sets the number of interactions per contact.

- **SetPeriodicCondition()** (in module pylmgc90.chipy.macro)
  - Description: Sets periodic boundary conditions.

- **SmoothForceComputation()** (in module pylmgc90.chipy.macro)
  - Description: Enables smooth force computation.

- **StockRloc()** (in module pylmgc90.chipy.macro)
  - Description: Stocks the Rloc values.
```

--------------------------------

### multiMAILx_GetNbElements

Source: https://lmgc90.pages-git-xen.lmgc.univ-montp2.fr/lmgc90_dev/chipy_lmgc90

Gets the number of elements for a specific multiMAILx instance.

```APIDOC
## GET /multiMAILx/GetNbElements

### Description
Gets the number of elements for a specific multiMAILx instance.

### Method
GET

### Endpoint
/multiMAILx/GetNbElements

### Parameters
#### Path Parameters
- **ivalue** (integer) - Required - The ID of the multiMAILx instance.

### Response
#### Success Response (200)
- **nb_elements** (integer) - The number of elements in the multiMAILx instance.

#### Response Example
```json
{
  "nb_elements": 100
}
```
```

--------------------------------

### mecaMAILx_GetPtrPreconW

Source: https://lmgc90.pages-git-xen.lmgc.univ-montp2.fr/lmgc90_dev/chipy_lmgc90

Gets a pointer on the preconW Matrix of a given body.

```APIDOC
## mecaMAILx_GetPtrPreconW

### Description
Gets a pointer on the preconW Matrix of a given body.

### Method
GET

### Endpoint
/websites/lmgc90_pages-git-xen_lmgc_univ-montp2_fr_lmgc90_dev/mecaMAILx_GetPtrPreconW

### Parameters
#### Path Parameters
- **ibdyty** (integer) - Required - Rank of the mecaMAILx.

### Response
#### Success Response (200)
- **pcW** (double array) - Reference on the desired vector seen as a numpy array.

#### Response Example
```json
{
  "pcW": [[1.0, 0.0], [0.0, 1.0]]
}
```
```

--------------------------------

### Initialize and Configure LMGC90 Simulation Script

Source: https://lmgc90.pages-git-xen.lmgc.univ-montp2.fr/lmgc90_dev/chipy_common

This Python script demonstrates the common initialization steps for an LMGC90 simulation using the chipy module. It covers setting up the simulation environment, defining physical and numerical parameters, reading input data, and preparing for post-processing. Key dependencies include the 'pylmgc90.chipy' module.

```python
# importing chipy module
from pylmgc90 import chipy

# Initializing
chipy.Initialize()

# checking/creating mandatory subfolders
chipy.checkDirectories()

# logMes
# chipy.utilities_DisableLogMes()

#
# defining some variables
#

# space dimension
dim = 2

# modeling hypothesis ( 1 = plain strain, 2 = plain stress, 3 = axi-symmetry)
mhyp = 1

# time evolution parameters
dt = 1e-3
nb_steps = 100

# theta integrator parameter
theta = 0.5

# deformable True or False
deformable = False

# interaction parameters
Rloc_tol = 5.e-2

# nlgs parameters
tol = 1e-4
relax = 1.0
norm = 'Quad '
gs_it1 = 50
gs_it2 = 10
solver_type='Stored_Delassus_Loops         '

# write parameter
freq_write   = 10

# display parameters
freq_display = 10

#
# read and load
#

# Set space dimension
chipy.SetDimension(dim,mhyp)
#
chipy.utilities_logMes('INIT TIME STEPPING')
chipy.TimeEvolution_SetTimeStep(dt)
chipy.Integrator_InitTheta(theta)
#
chipy.utilities_logMes('READ DATBOX')
chipy.ReadDatbox(deformable)

#
# open display & postpro
#

chipy.utilities_logMes('DISPLAY & WRITE')
chipy.OpenDisplayFiles()
chipy.OpenPostproFiles()

# if HDF5 is available
chipy.InitHDF5('lmgc90.h5')

#
# simulation part ...
#

# ... calls a simulation time loop

#
# close display & postpro
#
chipy.CloseDisplayFiles()
chipy.ClosePostproFiles()

# this is the end
chipy.Finalize()

```

--------------------------------

### RBDY2_GetPtrMass

Source: https://lmgc90.pages-git-xen.lmgc.univ-montp2.fr/lmgc90_dev/chipy_lmgc90

Gets a pointer to the mass matrix of a rigid body.

```APIDOC
## RBDY2_GetPtrMass

### Description
Get a pointer onto the mass matrix of a rigid body.

### Method
GET

### Endpoint
/websites/lmgc90_pages-git-xen_lmgc_univ-montp2_fr_lmgc90_dev/pylmgc90/chipy/lmgc90/RBDY2_GetPtrMass

### Parameters
#### Path Parameters
None

#### Query Parameters
- **ibdyty** (int) - Required - Index of the RBDY2.

### Request Example
```python
mass = RBDY2_GetPtrMass(ibdyty)
```

### Response
#### Success Response (200)
- **mass** (double) - The mass matrix of the RBDY2.
```

--------------------------------

### paneresse_simple Wall Construction

Source: https://lmgc90.pages-git-xen.lmgc.univ-montp2.fr/lmgc90_dev/pre_classes

API documentation for building simple brick walls using the paneresse_simple class.

```APIDOC
## POST /api/websites/lmgc90_pages-git-xen_lmgc_univ-montp2_fr_lmgc90_dev/pre/paneresse_simple/buildRigidWall

### Description
Builds a rigid wall using the "apareil en paneresses, simple" method. It generates a list of rigid avatars representing the bricks of the wall.

### Method
POST

### Endpoint
/api/websites/lmgc90_pages-git-xen_lmgc_univ-montp2_fr_lmgc90_dev/pre/paneresse_simple/buildRigidWall

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **origin** (object) - Required - The origin location of the wall.
- **model** (string) - Required - The rigid model for the bricks.
- **material** (string) - Required - The material the bricks are made of.
- **color** (string) - Optional - The color of the contactors. Defaults to ['BLUEx', 'REDxx'].
- **rtol** (float) - Optional - Relative tolerance used in floating-point comparisons. Defaults to 1e-5.

### Request Example
```json
{
  "origin": {"x": 0, "y": 0, "z": 0},
  "model": "brick_model",
  "material": "brick_material",
  "color": "REDxx",
  "rtol": 1e-5
}
```

### Response
#### Success Response (200)
- **wall_id** (string) - Identifier for the constructed wall.

#### Response Example
```json
{
  "wall_id": "wall_123"
}
```

## POST /api/websites/lmgc90_pages-git-xen_lmgc_univ-montp2_fr_lmgc90_dev/pre/paneresse_simple/buildRigidWallWithoutHalfBricks

### Description
Builds a rigid wall without half bricks, suitable for "harpage" readiness. It generates a list of rigid avatars representing the bricks of the wall.

### Method
POST

### Endpoint
/api/websites/lmgc90_pages-git-xen_lmgc_univ-montp2_fr_lmgc90_dev/pre/paneresse_simple/buildRigidWallWithoutHalfBricks

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **origin** (object) - Required - The origin location of the wall.
- **model** (string) - Required - The rigid model for the bricks.
- **material** (string) - Required - The material the bricks are made of.
- **color** (string) - Optional - The color of the contactors. Defaults to ['BLUEx', 'REDxx'].
- **rtol** (float) - Optional - Relative tolerance used in floating-point comparisons. Defaults to 1e-5.

### Request Example
```json
{
  "origin": {"x": 0, "y": 0, "z": 0},
  "model": "brick_model",
  "material": "brick_material",
  "color": "REDxx",
  "rtol": 1e-5
}
```

### Response
#### Success Response (200)
- **wall_id** (string) - Identifier for the constructed wall.

#### Response Example
```json
{
  "wall_id": "wall_456"
}
```
```

--------------------------------

### Write Evolution File for Boundary Conditions in Python

Source: https://lmgc90.pages-git-xen.lmgc.univ-montp2.fr/lmgc90_dev/pre_classes

Writes an evolution file used to apply specific boundary conditions. It takes a function of time `f` and a list of instants, evaluating `f(t)` for each `t` in the list and writing the (t, f(t)) pairs to a file. Optional path and filename can be specified.

```python
pylmgc90.pre.writeEvolution(_f_ , _instants_ , _path =''_, _name ='evolution.dat'_)
```

--------------------------------

### RBDY2_GetPtrVector

Source: https://lmgc90.pages-git-xen.lmgc.univ-montp2.fr/lmgc90_dev/chipy_lmgc90

Gets a pointer to a specific vector of a rigid body.

```APIDOC
## RBDY2_GetPtrVector

### Description
Get a pointer on a vector of a given rigid body (RBDY2).

Possible values for `datatype` field are:
  * "Coor0": reference coordinates
  * "Xbeg_": cumulated displacements over time at beginning of time step
  * "X____": cumulated displacements over time in computed configuration
  * "Vbeg_": velocity at beginning of time step
  * "V____": velocity in computed configuration
  * "Vaux_": working array for velocity
  * "Ireac": contact impulse
  * "Iaux_": working array for impulse
  * "Fext_": external forces

### Method
GET

### Endpoint
/websites/lmgc90_pages-git-xen_lmgc_univ-montp2_fr_lmgc90_dev/pylmgc90/chipy/lmgc90/RBDY2_GetPtrVector

### Parameters
#### Path Parameters
None

#### Query Parameters
- **datatype** (string of size 5) - Required - The type of vector to retrieve.
- **ibdyty** (integer) - Required - Rank of the considered body.

### Request Example
```python
vector_ptr = RBDY2_GetPtrVector(datatype, ibdyty)
```

### Response
#### Success Response (200)
- **vector_ptr** (double array) - A reference to the desired vector, viewable as a NumPy array.
```

--------------------------------

### RBDY2_GetNbContactor

Source: https://lmgc90.pages-git-xen.lmgc.univ-montp2.fr/lmgc90_dev/chipy_lmgc90

Gets the number of contactors attached to a rigid body.

```APIDOC
## RBDY2_GetNbContactor

### Description
Get the number of contactors of a rigid body (RBDY2).

### Method
GET

### Endpoint
/websites/lmgc90_pages-git-xen_lmgc_univ-montp2_fr_lmgc90_dev/pylmgc90/chipy/lmgc90/RBDY2_GetNbContactor

### Parameters
#### Path Parameters
None

#### Query Parameters
- **ibdyty** (integer) - Required - Rank of the RBDY2 in the container.

### Request Example
```python
nb = RBDY2_GetNbContactor(ibdyty)
```

### Response
#### Success Response (200)
- **nb** (integer) - Number of contactors attached to the RBDY2.
```

--------------------------------

### pylmgc90.pre.rigidDisk

Source: https://lmgc90.pages-git-xen.lmgc.univ-montp2.fr/lmgc90_dev/pre_classes

Builds a rigid disk particle and returns the generated body.

```APIDOC
## POST /pylmgc90.pre/rigidDisk

### Description
Builds a rigid disk particle and returns the generated body.

### Method
POST

### Endpoint
/pylmgc90.pre/rigidDisk

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **r** (float) - Required - Radius of the particle.
- **center** (list[float]) - Required - Position of the center of inertia in the global frame (2D vector).
- **model** (string) - Required - Rigid model for the particle.
- **material** (string) - Required - The particle is made of this material.
- **color** (string) - Optional - Color of the contactor (default: 'BLUEx').
- **number** (int) - Optional - Index of the avatar (for compatibility).
- **is_Hollow** (bool) - Optional - Whether the contactor should be hollow (default: False).

### Request Example
```json
{
  "r": 1.0,
  "center": [0.0, 0.0],
  "model": "RIGID",
  "material": "MAT1",
  "color": "REDxx",
  "is_Hollow": false
}
```

### Response
#### Success Response (200)
- **body** (object) - The generated rigid disk body.

#### Response Example
```json
{
  "body": {
    "type": "rigidDisk",
    "radius": 1.0,
    "center": [0.0, 0.0],
    "model": "RIGID",
    "material": "MAT1",
    "color": "REDxx",
    "is_Hollow": false
  }
}
```
```

--------------------------------

### mecaMAILx_GetVectorFieldRank

Source: https://lmgc90.pages-git-xen.lmgc.univ-montp2.fr/lmgc90_dev/chipy_lmgc90

Gets the rank of a vector field of an element of a body from its name.

```APIDOC
## mecaMAILx_GetVectorFieldRank

### Description
Gets the rank of a vector field of an element of a body from its name.

### Method
GET

### Endpoint
/websites/lmgc90_pages-git-xen_lmgc_univ-montp2_fr_lmgc90_dev/mecaMAILx_GetVectorFieldRank

### Parameters
#### Path Parameters
- **ibdyty** (integer) - Required - ID of the concerned body.
- **iblmty** (integer) - Required - ID of the concerned element.
- **name** (string) - Required - Name of the desired vector field.

### Response
#### Success Response (200)
- **f_rank** (integer) - Rank of the corresponding vector field.

#### Response Example
```json
{
  "f_rank": 2
}
```
```

--------------------------------

### Generate Visualization Files A Posteriori with chipy

Source: https://lmgc90.pages-git-xen.lmgc.univ-montp2.fr/lmgc90_dev/restart_index

This script demonstrates how to generate visualization files after a simulation has finished. It reads the simulation data from an HDF5 file, initializes display file writing, and then iterates through each time step to write the display files. It requires the 'pylmgc90' library and uses 'h5py' for HDF5 interaction.

```python
import h5py

h5_file = 'lmgc90.h5'
hf = h5py.File(h5_file)
nb_record = int( hf['Simulation/nb_record'][()] )
dim = int( hf['Simulation/dimension'][()] )
hf.close()

from pylmgc90 import chipy

chipy.Initialize()
chipy.checkDirectories()

chipy.Initialize()

chipy.SetDimension(dim)

chipy.ReadDatbox()

chipy.OpenDisplayFiles()

chipy.ComputeMass()

for k in range(1,nb_record+1,1):

  chipy.ReadIni(k,h5_file)
  chipy.ComputeFext()
  chipy.ComputeRnod()
  chipy.WriteDisplayFiles(freq_display)

chipy.CloseDisplayFiles()
chipy.Finalize()

```

--------------------------------

### mecaMAILx_GetScalarFieldRank

Source: https://lmgc90.pages-git-xen.lmgc.univ-montp2.fr/lmgc90_dev/chipy_lmgc90

Gets the rank of a scalar field of an element of a body from its name.

```APIDOC
## mecaMAILx_GetScalarFieldRank

### Description
Gets the rank of a scalar field of an element of a body from its name.

### Method
GET

### Endpoint
/websites/lmgc90_pages-git-xen_lmgc_univ-montp2_fr_lmgc90_dev/mecaMAILx_GetScalarFieldRank

### Parameters
#### Path Parameters
- **ibdyty** (integer) - Required - ID of the concerned body.
- **iblmty** (integer) - Required - ID of the concerned element.
- **name** (string) - Required - Name of the desired field.

### Response
#### Success Response (200)
- **f_rank** (integer) - Rank of the corresponding field.

#### Response Example
```json
{
  "f_rank": 1
}
```
```

--------------------------------

### Utility Functions

Source: https://lmgc90.pages-git-xen.lmgc.univ-montp2.fr/lmgc90_dev/chipy_macro

Helper functions for managing display settings and directory checks.

```APIDOC
## addRegistersToDisplay

### Description
Decide to automatically add registered field to WriteDisplayFiles.

### Method
`addRegistersToDisplay`

### Endpoint
`/websites/lmgc90_pages-git-xen_lmgc_univ-montp2_fr_lmgc90_dev/pylmgc90/chipy/macro/addRegistersToDisplay`

### Parameters
#### Query Parameters
* **_to_add** (boolean) - Optional - To enable (default) or disable automatic addition of registered fields. Default is True.

### Request Example
```json
{
  "_to_add": false
}
```

### Response
#### Success Response (200)
None

## checkDirectories

### Description
Check if DATBOX directory exists (if not, it stops). Create OUTBOX, POSTPRO and/or DISPLAY directory if one does not exists.

### Method
`checkDirectories`

### Endpoint
`/websites/lmgc90_pages-git-xen_lmgc_univ-montp2_fr_lmgc90_dev/pylmgc90/chipy/macro/checkDirectories`

### Parameters
#### Query Parameters
* **_checkDATBOX** (bool) - Optional - Whether to check for the DATBOX directory. Default is True.

### Request Example
```json
{
  "_checkDATBOX": false
}
```

### Response
#### Success Response (200)
None

```

--------------------------------

### inter_handler_2D_tgetInternal

Source: https://lmgc90.pages-git-xen.lmgc.univ-montp2.fr/lmgc90_dev/chipy_lmgc90

Gets the internal data of an interaction stored in this data structure.

```APIDOC
## GET /inter_handler_2D_tgetInternal

### Description
Gets the internal data of an interaction stored in this data structure.

### Method
GET

### Endpoint
/inter_handler_2D_tgetInternal

### Parameters
#### Query Parameters
- **inter_id** (integer) - Required - Type of interaction (lmgc90 parameter)
- **icdan** (integer) - Required - Index of the interaction of the selected type

### Returns
#### Success Response (200)
- **internal** (double array) - The new values array representing internal data.
```

--------------------------------

### Build Rigid Wall (paneresses_simple)

Source: https://lmgc90.pages-git-xen.lmgc.univ-montp2.fr/lmgc90_dev/pre_classes

Constructs a rigid wall using the 'paneresses_simple' brick arrangement. This method generates rigid avatars for each brick in the wall. It requires origin, model, material, and optionally colors and relative tolerance.

```python
pylmgc90.pre.paneresse_simple.buildRigidWall(origin, model, material, color, rtol=1e-5)
```

--------------------------------

### inter_handler_2D_tgetIData

Source: https://lmgc90.pages-git-xen.lmgc.univ-montp2.fr/lmgc90_dev/chipy_lmgc90

Gets the integer data of an interaction stored in the data structure.

```APIDOC
## GET /inter_handler_2D_tgetIData

### Description
Gets the integer data of an interaction stored in this data structure. The 'idata' vector holds cd body type, an body type, cd body id, an body id, cd contactor type, an contactory type, cd contactor id, an contactor id, cd subcontactor id, an subcontactor id, tact law id, status, number of internals.

### Method
GET

### Endpoint
/inter_handler_2D_tgetIData

### Parameters
#### Query Parameters
- **inter_id** (integer) - Required - Type of interaction (lmgc90 parameter)
- **icdan** (integer) - Required - Index of the interaction of the selected type

### Returns
#### Success Response (200)
- **idata** (integer array) - The values array containing interaction integer data.
```

--------------------------------

### mecaMAILx_InitPreconW

Source: https://lmgc90.pages-git-xen.lmgc.univ-montp2.fr/lmgc90_dev/chipy_lmgc90

Initializes an empty precon W matrix.

```APIDOC
## mecaMAILx_InitPreconW

### Description
Initializes an empty precon W matrix.

### Method
POST

### Endpoint
/websites/lmgc90_pages-git-xen_lmgc_univ-montp2_fr_lmgc90_dev/mecaMAILx_InitPreconW

### Parameters
No parameters required.

### Response
#### Success Response (200)
- Status: Operation successful.

#### Response Example
```json
{
  "status": "success"
}
```
```

--------------------------------

### RBDY2_GetNbRBDY2

Source: https://lmgc90.pages-git-xen.lmgc.univ-montp2.fr/lmgc90_dev/chipy_lmgc90

Gets the total number of rigid bodies (RBDY2) in the simulation.

```APIDOC
## RBDY2_GetNbRBDY2

### Description
Get the total number of rigid bodies (RBDY2) in the container.

### Method
GET

### Endpoint
/websites/lmgc90_pages-git-xen_lmgc_univ-montp2_fr_lmgc90_dev/pylmgc90/chipy/lmgc90/RBDY2_GetNbRBDY2

### Parameters
#### Path Parameters
None

#### Query Parameters
None

### Request Example
```python
nb_rbdy2 = RBDY2_GetNbRBDY2()
```

### Response
#### Success Response (200)
- **nb_rbdy2** (integer) - The number of RBDY2 bodies in the container.
```

--------------------------------

### Visualize Avatars Container in Python

Source: https://lmgc90.pages-git-xen.lmgc.univ-montp2.fr/lmgc90_dev/pre_classes

Creates a visualization window of a container of avatars using VTK. It allows for optionally displaying normalized axes and coloring bodies with boundary conditions.

```python
pylmgc90.pre.visuAvatars(_cont_ , _with_axis =False_, _drvdof_color =None_)
```

--------------------------------

### multiMAILx_GetVectorFieldRank

Source: https://lmgc90.pages-git-xen.lmgc.univ-montp2.fr/lmgc90_dev/chipy_lmgc90

Gets the rank of a vector field for an element of a body, given its name.

```APIDOC
## GET /multiMAILx/GetVectorFieldRank

### Description
Gets the rank of a vector field for an element of a body, given its name.

### Method
GET

### Endpoint
/multiMAILx/GetVectorFieldRank

### Parameters
#### Path Parameters
- **ibdyty** (integer) - Required - The ID of the concern body.
- **iblmty** (integer) - Required - The ID of the concern element.
- **name** (string) - Required - The name of the desired vector field.

### Response
#### Success Response (200)
- **f_rank** (integer) - The rank of the corresponding vector field.

#### Response Example
```json
{
  "field_rank": 8
}
```
```

--------------------------------

### multiMAILx_GetScalarFieldRank

Source: https://lmgc90.pages-git-xen.lmgc.univ-montp2.fr/lmgc90_dev/chipy_lmgc90

Gets the rank of a scalar field for an element of a body, given its name.

```APIDOC
## GET /multiMAILx/GetScalarFieldRank

### Description
Gets the rank of a scalar field for an element of a body, given its name.

### Method
GET

### Endpoint
/multiMAILx/GetScalarFieldRank

### Parameters
#### Path Parameters
- **ibdyty** (integer) - Required - The ID of the concern body.
- **iblmty** (integer) - Required - The ID of the concern element.
- **name** (string) - Required - The name of the desired field.

### Response
#### Success Response (200)
- **f_rank** (integer) - The rank of the corresponding field.

#### Response Example
```json
{
  "field_rank": 5
}
```
```
Tokens:
Raw