carputils.settings.settings.SettingsModule Class Reference

Public Member Functions
def	__init__ (self)
def	solver (self, args, kwargs)
def	default_cli (self, dry=False, kwargs)
	Generate a default command line interface object. More...

Static Public Attributes
	MECH_ELEMENT = solver.MECH_ELEMENT
	FLAVORS = solver.FLAVORS
	Available solver flavors. More...

Properties
	config = property
	SettingsNamespace object containing carputils configuration, generated from the carputils settings file. More...
	cli = property
	Command line arguments for the current run. More...
	dirs = property
	Directories where executables are searched for. More...
	revision = property
	Revision number of the CARP/openCARP executable. More...
	dependency_revisions = property
	makevars = property
	execs = property
	Executable paths for the current run configuration. More...
	platform = property
	summary = property
	Summary of the current run configuration. More...
	is_open_carp = property
	Is the current "CARP" executable an openCARP executable? More...

Constructor & Destructor Documentation

__init__()

def carputils.settings.settings.SettingsModule.__init__

(

self

)

Member Function Documentation

default_cli()

def carputils.settings.settings.SettingsModule.default_cli	(		self,
			dry = False,
			kwargs
	)

Generate a default command line interface object.

solver()

def carputils.settings.settings.SettingsModule.solver	(		self,
			args,
			kwargs
	)

Member Data Documentation

FLAVORS

carputils.settings.settings.SettingsModule.FLAVORS = solver.FLAVORS

static

Available solver flavors.

MECH_ELEMENT

carputils.settings.settings.SettingsModule.MECH_ELEMENT = solver.MECH_ELEMENT

static

Property Documentation

cli

carputils.settings.settings.SettingsModule.cli = property

static

Command line arguments for the current run.

config

carputils.settings.settings.SettingsModule.config = property

static

SettingsNamespace object containing carputils configuration, generated from the carputils settings file.

Values can be accessed via the dot notation (case-insensitive), e.g.

>>> from carputils import settings

>>> print(settings.config.MPIEXEC)
mpiexec

>>> print(settings.config.flavor)
petsc

dependency_revisions

carputils.settings.settings.SettingsModule.dependency_revisions = property

static

dirs

carputils.settings.settings.SettingsModule.dirs = property

static

Directories where executables are searched for.

execs

carputils.settings.settings.SettingsModule.execs = property

static

Executable paths for the current run configuration.

is_open_carp

carputils.settings.settings.SettingsModule.is_open_carp = property

static

Is the current "CARP" executable an openCARP executable?

makevars

carputils.settings.settings.SettingsModule.makevars = property

static

platform

carputils.settings.settings.SettingsModule.platform = property

static

revision

carputils.settings.settings.SettingsModule.revision = property

static

Revision number of the CARP/openCARP executable.

summary

carputils.settings.settings.SettingsModule.summary = property

static

Summary of the current run configuration.

---

The documentation for this class was generated from the following file:

• carputils/settings/settings.py