Input generator

General

Input

Regroup all AMITEX input parameters

Grid

Unit cell geometry (sizes, lengths...)

class py4amitex.input.Input

Regroup all AMITEX input parameters

property algorithmParameters

see AlgorithmParameters

generateFiles(self: py4amitex.input.Input) None

Generate all input files (XML, VTK, BIN) in resultsDir

property grid

Grid defining the unit cell and number of voxels

property loadingOutput

see LoadingOutput

property materials

see Materials

outputPrefix(self: py4amitex.input.Input) str

Prefix to output files

property resultsDir

Where generated and AMITEX output will be

class py4amitex.input.Grid

Unit cell geometry (sizes, lengths…)

allLinPoints(self: py4amitex.input.Grid) Iterator[int]
Returns:

an iterable over all points (linear representation) on the grid example

` C++ for(GridLinPoint p : grid.allLinPoints()) `

allPoints(self: py4amitex.input.Grid) Iterator[Annotated[list[int], FixedSize(3)]]
Returns:

an iterable over all points on the grid example

` C++ for(GridPoint p : grid.allPoints()) `

dims(self: py4amitex.input.Grid) Annotated[list[int], FixedSize(3)]

Per-axis number of voxels

distance(*args, **kwargs)

Overloaded function.

  1. distance(self: py4amitex.input.Grid, arg0: Annotated[list[int], FixedSize(3)], arg1: Annotated[list[int], FixedSize(3)]) -> float

Compute distance between two points

  1. distance(self: py4amitex.input.Grid, arg0: Annotated[list[int], FixedSize(3)], arg1: Annotated[list[float], FixedSize(3)]) -> float

linearize(self: py4amitex.input.Grid, arg0: Annotated[list[int], FixedSize(3)]) int

Get linearized position

Parameter p:

position in grid coordinates

setOrigin(self: py4amitex.input.Grid, arg0: Annotated[list[float], FixedSize(3)]) None
setPbc(self: py4amitex.input.Grid, arg0: Annotated[list[bool], FixedSize(3)]) None
totalSize(self: py4amitex.input.Grid) int

Total number of voxels

voxelLengths(self: py4amitex.input.Grid) Annotated[list[float], FixedSize(3)]

Lengths of a voxel

class py4amitex.input.Zone

Zone, that is a list of voxel positions

add(*args, **kwargs)

Overloaded function.

  1. add(self: py4amitex.input.Zone, arg0: Annotated[list[int], FixedSize(3)]) -> None

add a voxel to a zone

Parameter position:

voxel grid coordinate

  1. add(self: py4amitex.input.Zone, arg0: int) -> None

add a voxel to a zone

Parameter position:

voxel grid linearized position

  1. add(self: py4amitex.input.Zone, arg0: Iterator) -> None

add voxels with an iterator on grid points

linearPositions(self: py4amitex.input.Zone) list[int]

linear index of positions

numberVoxels(self: py4amitex.input.Zone) int
Returns:

number of voxels