carmapy.base

Essential functions for carmapy

Note

All of these fuctions are loaded into the top-level carmapy namespace. In other words you can access them like carmapy.load_carma(...) instead of carmapy.base.load_carma(...)

Functions

available_species()	Prints the gas species available in the carmapy defaults
included_mucos(…)	Prints the cosines of the contanct angle available in carmapy defaults.
load_carma(…)	Restores a carma object from files.

carmapy.base.available_species()

Prints the gas species available in the carmapy defaults

Return type:

None

carmapy.base.included_mucos(species)

Prints the cosines of the contanct angle available in carmapy defaults. Prints the dictionary of potential seed particles and their contact angles for the requested species from the carmapy defaults.

Parameters:

species (str) – The name of the gas species for which to see the available contact angles

carmapy.base.load_carma(path, restart=0)

Restores a carma object from files. Loads in the configuration stored by Carma.run()

Parameters:

• path (str) – The path to the directory holding the carma files

• restart (int) – If 1, future calls to Carma.run() for this object will resume the simulation from the most recently saved state. If 0, instead calls to Carma.run() will restart the simulation from the beginning. Either way, the current output files will be overwritten by default. By default 0

Returns:

The loaded Carma object

Return type:

Carma