libs.simulation.ngsolve.CSGeometries package

Submodules

libs.simulation.ngsolve.CSGeometries.CSGComponents module

class libs.simulation.ngsolve.CSGeometries.CSGComponents.CSGComponents(components: List[Component])

Bases: object

Wrapper class to determine the type of the component and initiate an object of the specific class to build the

geometry with netgen.csg.CSGeometry elements.

Parameters:

components (List[Component]) – List of components parameters.

bodies: List[Solid]

static build_component_body(component: Component) → Solid

Method to generate the geometry of a component with the parameters specified in the committed component

object.

Parameters:

component (Component) – Component parameters.

Returns:

Component geometry.

Return type:

netgen.csg.Solid

components: List[Component]

libs.simulation.ngsolve.CSGeometries.CSGCuboidMagnet module

class libs.simulation.ngsolve.CSGeometries.CSGCuboidMagnet.CSGCuboidMagnet(cuboid_magnet: CuboidMagnet)

Bases: object

Generates the geometry for a cuboid magnet in the simulation with netgen.csg.CSGeometry elements.

Parameters:

cuboid_magnet (CuboidMagnet) – Object of the CuboidMagnet class.

body: Solid

build_body() → Solid

Builds the geometry of the cuboid magnet with netgen.csg.CSGeometry elements.

Returns:

Cuboid magnet geometry.

Type:

netgen.csg.Solid

cuboid_magnet: CuboidMagnet

libs.simulation.ngsolve.CSGeometries.CSGEnvironment module

class libs.simulation.ngsolve.CSGeometries.CSGEnvironment.CSGEnvironment(sim_params: SimParams)

Bases: object

Generates the geometry for the simulation boundaries with netgen.csg.CSGeometry elements.

Parameters:

sim_params (SimParams) – Object of the SimParams class.

body: Solid

build_body() → Solid

Builds the body of the bounding environment of the scenery.

Returns:

Geometry of the bounding environment.

Return type:

tuple

sim_params: SimParams

libs.simulation.ngsolve.CSGeometries.CSGGMRSensor module

class libs.simulation.ngsolve.CSGeometries.CSGGMRSensor.CSGGMRSensor(gmr_sensor: GMRSensor)

Bases: object

Generates the geometry for a Sensitec GMR sensor in the simulation with netgen.csg.CSGeometry elements.

Parameters:

gmr_sensor (GMRSensor) – Object of the GMRSensor class

body: Solid

build_body() → Solid

Builds the geometry of the Sensitec GMR sensor with netgen.csg.CSGeometry elements.

Returns:

GMR Sensor geometry.

Type:

netgen.csg.Solid

gmr_sensor: GMRSensor

libs.simulation.ngsolve.CSGeometries.CSGGear module

class libs.simulation.ngsolve.CSGeometries.CSGGear.CSGGear(gear: Gear)

Bases: object

Generates the geometry for a gear in the simulation with netgen.csg.CSGeometry elements.

Parameters:

gear (Gear) – Object of the gear class.

body: Solid

build_body() → Solid

Builds the geometry of the gear with netgen.csg.CSGeometry elements.

Returns:

Gear geometry.

Type:

netgen.csg.Solid

gear: Gear

libs.simulation.ngsolve.CSGeometries.CSGGearRack module

class libs.simulation.ngsolve.CSGeometries.CSGGearRack.CSGGearRack(gear_rack: GearRack)

Bases: object

Generates the geometry for a gear rack in the simulation with netgen.csg.CSGeometry elements.

Parameters:

gear_rack (GearRack) – Object of the gear rack class.

body: Solid

build_body() → Solid

Builds the geometry of the gear rack with netgen.csg.CSGeometry elements.

Returns:

Gear Rack geometry.

Type:

netgen.csg.Solid

gear_rack: GearRack

libs.simulation.ngsolve.CSGeometries.CSGHallSensor module

class libs.simulation.ngsolve.CSGeometries.CSGHallSensor.CSGHallSensor(hall_sensor: HallSensor)

Bases: object

Generates the geometry for a hall sensor case in the simulation with netgen.csg.CSGeometry elements.

Parameters:

hall_sensor (HallSensor) – Object of the HallSensor class.

body: Solid

build_body() → Solid

Builds the geometry of the hall sensor with netgen.csg.CSGeometry elements.

Returns:

Hall sensor geometry.

Type:

netgen.csg.Solid

hall_sensor: HallSensor

libs.simulation.ngsolve.CSGeometries.CSGMagnets module

class libs.simulation.ngsolve.CSGeometries.CSGMagnets.CSGMagnets(magnets: List[Magnet])

Bases: object

Wrapper class to determine the type of the magnet and initiate an object of the specific class to build the

geometry with netgen.csg.CSGeometry elements.

Parameters:

magnets (List[Magnet]) – List of magnets parameters.

bodies: List[Solid]

static build_magnet_body(magnet: Magnet) → Solid

Method to generate the geometry of a magnet with the parameters specified in the committed component

object.

Parameters:

magnet (Magnet) – Magnet parameters.

Returns:

Magnet geometry.

Return type:

netgen.csg.Solid

magnets: List[Magnet]

libs.simulation.ngsolve.CSGeometries.CSGRodMagnet module

class libs.simulation.ngsolve.CSGeometries.CSGRodMagnet.CSGRodMagnet(rod_magnet: RodMagnet)

Bases: object

Generates the geometry for a rod magnet in the simulation with netgen.csg.CSGeometry elements.

Parameters:

rod_magnet (RodMagnet) – Object of the RodMagnet class.

body: Solid

build_body() → Solid

Builds the geometry of the rod magnet with netgen.csg.CSGeometry elements.

Returns:

Rod magnet geometry.

Type:

netgen.csg.Solid

rod_magnet: RodMagnet

libs.simulation.ngsolve.CSGeometries.CSGSensorTemplate module

class libs.simulation.ngsolve.CSGeometries.CSGSensorTemplate.CSGSensorTemplate(template: SensorTemplate)

Bases: object

Generates the geometry for of the template element in the simulation with netgen.csg.CSGeometry elements.

Parameters:

template (SensorTemplate) – Object of the SensorTemplate class.

body: Solid

build_body() → Solid

Builds the geometry of the template with netgen.csg.CSGeometry elements.

Returns:

Template geometry.

Type:

netgen.csg.Solid

template: SensorTemplate

libs.simulation.ngsolve.CSGeometries.CSGSensors module

class libs.simulation.ngsolve.CSGeometries.CSGSensors.CSGSensors(sensors: List[Sensor])

Bases: object

Wrapper class to determine the type of the sensor and initiate an object of the specific class to build the

geometry with netgen.csg.CSGeometry elements.

Parameters:

sensors (List[Sensor]) – List of sensors parameters.

bodies: List[Solid]

static build_sensor_body(sensor: Sensor) → Solid

Method to generate the geometry of a sensor with the parameters specified in the committed component

object.

Parameters:

sensor (Sensor) – Sensor parameters.

Returns:

Sensor geometry.

Return type:

netgen.csg.Solid

sensors: List[Sensor]

libs.simulation.ngsolve.CSGeometries.CSGShaft module

class libs.simulation.ngsolve.CSGeometries.CSGShaft.CSGShaft(shaft: Shaft)

Bases: object

Generates the geometry for a shaft in the simulation with netgen.csg.CSGeometry elements.

Parameters:

shaft (Shaft) – Object of the shaft class.

body: Solid

build_body() → Solid

Builds the geometry of the shaft with netgen.csg.CSGeometry elements.

Returns:

Shaft geometry.

Type:

netgen.csg.Solid

shaft: Shaft

Module contents