py21cmfast.inputs¶
Input parameter classes.
There are four input parameter/option classes, not all of which are required for any
given function. They are UserParams
, CosmoParams
, AstroParams
and FlagOptions
. Each of them defines a number of variables, and all of these
have default values, to minimize the burden on the user. These defaults are accessed via
the _defaults_
class attribute of each class. The available parameters for each are
listed in the documentation for each class below.
Along with these, the module exposes global_params
, a singleton object of type
GlobalParams
, which is a simple class providing read/write access to a number of parameters
used throughout the computation which are very rarely varied.
Functions
|
Cross-validate input parameters from different structs. |
Classes
|
Astrophysical parameters. |
|
Cosmological parameters (with defaults) which translates to a C struct. |
|
Flag-style options for the ionization routines. |
|
Global parameters for 21cmFAST. |
|
Structure containing user parameters (with defaults). |
Exceptions
|
Error when two parameters from different structs aren't consistent. |