optimus.utils.parameters

Module Contents

Classes

DefaultParameters

LinalgParameters

IncidentFieldParallelProcessingParameters

PreconditioningParameters

OsrcParameters

PostProcessingParameters

BemParameters

class optimus.utils.parameters.DefaultParameters
print()

Print all parameters.

class optimus.utils.parameters.LinalgParameters
print(prefix='')

Print all parameters.

class optimus.utils.parameters.IncidentFieldParallelProcessingParameters
print(prefix='')

Print all parameters.

class optimus.utils.parameters.PreconditioningParameters
print(prefix='')

Print all parameters.

class optimus.utils.parameters.OsrcParameters
print(prefix='')

Print all parameters.

class optimus.utils.parameters.PostProcessingParameters
print(prefix='')

Print all parameters.

class optimus.utils.parameters.BemParameters
print(prefix='')

Print all parameters.

print_current_hmat_parameters(prefix='')

Print the current H-matrix parameters.

set_matrix_assembly_type(assembly_type)

Set the assembly type of the boundary integral operators in BEMPP.

Parameters
assembly_typestr

The type of operator assembly: either “dense” or “hmat”

set_field_assembly_type(assembly_type)

Set the assembly type of the potential integral operators in BEMPP.

Parameters
assembly_typestr

The type of operator assembly: either “dense” or “hmat”

static _process_assembly_type(assembly_type)

Process assembly type input

set_matrix_hmat(eps=None, max_rank=None, max_block_size=None)

Set the assembly type of the boundary integral operators in BEMPP.

Parameters
epsfloat

The precision of the H-matrix compression.

max_rankint

The maximum rank of the H-matrix blocks.

max_block_sizeint

The maximum size of the H-matrix blocks.

set_field_hmat(eps=None, max_rank=None, max_block_size=None)

Set the assembly type of the potential integral operators in BEMPP.

Parameters
epsfloat

The precision of the H-matrix compression.

max_rankint

The maximum rank of the H-matrix blocks.

max_block_sizeint

The maximum size of the H-matrix blocks.

update_hmat_parameters(operator_type)

Update the H-matrix parameters of BEMPP for matrix or field calculations.

Remember that BEMPP has only one set of global parameter for the hierarchical matrix compression, which is used for both the boundary and potential operators.

Parameters
operator_typestr

The type of operator: either ‘boundary’ or ‘potential’.

set_quadrature_order(operator_type, region, order)

Set the quadrature order for the numerical integration scheme.

Parameters
operator_typestr

The operator type, either ‘boundary’, ‘potential’ or ‘all’.

regionstr

The integration region, either ‘singular’, ‘near’, ‘medium’, ‘far’ or ‘all’.

orderint

The integration order.