carputils
Doxygen code documentation for the python framework controlling openCARP
Classes | Functions | Variables
carputils.settings.solver Namespace Reference

Classes

class  SolverOptions
 A container class with some convenience methods for setting up openCARP options. More...
 

Functions

def options (config, cli, makevars, mech_symmetric=False)
 Determine the solver options for the current run configuration. More...
 

Variables

tuple MECH_ELEMENT = ('P1-P0', 'P1-P1-DB', 'MINI')
 
tuple FLAVORS = ('petsc', 'ginkgo', 'petsc-gamg-agg', 'petsc-pipelined', 'boomeramg', 'boomeramg-pipelined', 'parasails', 'pt', 'direct')
 

Function Documentation

◆ options()

def carputils.settings.solver.options (   config,
  cli,
  makevars,
  mech_symmetric = False 
)

Determine the solver options for the current run configuration.

Parameters

config carputils.settings.namespace.SettingsNamespace Settings from the settings.yaml config file cli argparse.Namespace The command line options mech_symmetric bool, optional Use symmetric mechanics solver (default: False)

Returns

SolverOptions Object containing the generated solver options

Variable Documentation

◆ FLAVORS

tuple carputils.settings.solver.FLAVORS = ('petsc', 'ginkgo', 'petsc-gamg-agg', 'petsc-pipelined', 'boomeramg', 'boomeramg-pipelined', 'parasails', 'pt', 'direct')

◆ MECH_ELEMENT

tuple carputils.settings.solver.MECH_ELEMENT = ('P1-P0', 'P1-P1-DB', 'MINI')