optimus.model

Submodules

Package Contents

Functions

create_default_model(source, geometry, exterior, interior)

Create an acoustics model with default settings.

create_acoustic_model(source, geometry, exterior, interior)

Create a preconditioned boundary integral equation for acoustic wave propagation. For multiple domains, a list of geometries and interior materials need

optimus.model.create_default_model(source, geometry, exterior, interior)

Create an acoustics model with default settings.

For multiple domains, a list of geometries and interior materials need to be specified, with equal length. They are matched by order.

Parameters
sourceoptimus.Source

The Optimus representation of a source field.

geometryoptimus.Geometry

The Optimus representation of the geometry, with the grid of the scatterers. For multiple domains, provide a list of geometries.

exterioroptimus.Material

The Optimus representation of the material for the unbounded exterior region.

interioroptimus.Material

The Optimus representation of the material for the bounded scatterer. For multiple domains, provide a list of materials.

Returns
modeloptimus.Model

The Optimus representation of the the BEM model of acoustic wave propagation in the interior and exterior domains.

optimus.model.create_acoustic_model(source, geometry, exterior, interior, formulation='pmchwt', formulation_parameters=None, preconditioner='mass', preconditioner_parameters=None)

Create a preconditioned boundary integral equation for acoustic wave propagation. For multiple domains, a list of geometries and interior materials need to be specified, with equal length. They are matched by order.

Parameters
sourceoptimus.Source

The Optimus representation of a source field.

geometryoptimus.Geometry

The Optimus representation of the geometry, with the grid of the scatterers. For multiple domains, provide a list of geometries.

exterioroptimus.Material

The Optimus representation of the material for the unbounded exterior region.

interioroptimus.Material

The Optimus representation of the material for the bounded scatterer. For multiple domains, provide a list of materials.

formulationstr

The type of boundary integral formulation.

formulation_parametersdict

The parameters for the boundary integral formulation.

preconditionerstr

The type of operator preconditioner.

preconditioner_parametersdict

The parameters for the operator preconditioner.

Returns
modeloptimus.Model

The Optimus representation of the the BEM model of acoustic wave propagation in the interior and exterior domains.