TidalPy.Extending.burnman package
Subpackages
Submodules
TidalPy.Extending.burnman.build module
- TidalPy.Extending.burnman.build.build_burnman_world(planet_config: dict, verbose: bool = False) Tuple[None, Tuple[None, ...]][source]
Builds a BurnMan planet from a provided configuration dictionary.
- Parameters:
planet_config (dict) – Dictionary of planet configurations used to initialize layers and the planet.
verbose (bool = False) – If True, BurnMan will print more information to console.
- Returns:
burnman_world (burnman.Planet) – An initialized and built burnman planet class
burnman_layers (Tuple[burnman.Layer, …]) – An ordered list of initialized burnman layers
- TidalPy.Extending.burnman.build.build_layer(layer_name: str, layer_config: dict, burnman_verbose: str = False) None[source]
Build a Burnman layer
- Parameters:
layer_name (str) – Name of the layer
layer_config (dict) – Dictionary of layer configurations used to initialize the layer
burnman_verbose (bool, default = False) – Determines the verboseness of the BurnMan package.
- Returns:
layer – An initialized burnman layer
- Return type:
TidalPy.Extending.burnman.burnman_defaultc module
TidalPy.Extending.burnman.burnman_layer module
- class TidalPy.Extending.burnman.burnman_layer.BurnmanLayer[source]
Bases:
PhysicsLayer- Layer object to store parameters calculated by the Burnman software. Additionally it contains properties and
functionality that matches the TidalPy PhysicsLayer.
See also
TidalPy.structures.layers.PhysicsLayer- property bm_layer: None
- property bm_material: None
- geotherm(avg_temperature: float = None)[source]
Calculates layer’s geotherm based on an average temperature (or layer’s current temperature)
- Returns:
temperature_profile – numpy array of the adiabatic temperature profile
- Return type:
np.ndarray
- layer_class = 'burnman'
- property pressure
Layer’s dynamic pressure used in calculations
- reinit(initial_init: bool = False, initialize_geometry: bool = False)[source]
Reinitialize the physical object by pulling in any potentially new configurations
- Parameters:
initial_init (bool = False) – Set to True for the first time an instance is created.
set_by_burnman (bool = False) – Set to True if a Burnman layer/world constructor is calling reinit
initialize_geometry (bool = False) – Set to True if the set_geometry method should be called from within reinit
- set_geometry(radius: float = None, mass: float = None, thickness: float = None, mass_below: float = 0.0, update_state_geometry: bool = True, build_slices: bool = True)[source]
Calculates and sets the layer’s physical parameters based on user provided input.
For a BurnmanLayer almost all of the geometry is set by the results of the burnman evaluation.
Assumptions
Spherical Geometry
- param radius:
Outer radius of object [m]
- type radius:
float = None
- param mass:
Mass of object [kg]
- type mass:
float = None
- param thickness:
Thickness of the object [m]
- type thickness:
float = None
- param mass_below:
Mass below this object (only applicable for shell-like structures) Used in gravity and pressure calculations
- type mass_below:
float = 0.
- param update_state_geometry:
Update the class’ state geometry
- type update_state_geometry:
bool = True
- param build_slices:
If True, method will attempt to calculate gravities, densities, etc. for each slice.
- type build_slices:
bool = True
- set_state(temperature: float | float64 | ndarray = None, pressure: float | float64 | ndarray = None, viscosity: float | float64 | ndarray = None, shear_modulus: float | float64 | ndarray = None)[source]
Set the layer’s state properties
- Parameters:
temperature (FloatArray = None) – New dynamic temperature for the layer [K].
pressure (FloatArray = None) – New dynamic pressure for the layer [Pa].
viscosity (FloatArray = None) – The new viscosity of the layer in [Pa s]
shear_modulus (FloatArray = None) – The new shear modulus of the layer in [Pa]
- set_static_pressure(pressure_above: float = None, build_slices: bool = True, called_from_burnman: bool = True)[source]
Sets the static pressure for the physical structure.
- Static here indicates that this is not a dynamic pressure used in many calculations. The static pressure can
be used in place of the dynamic pressure, but that is not always the case.
- Parameters:
pressure_above (float = None) –
- Pressure above this structure. If this is a layer, then it is the pressure at the base of the overlying
layer. If it is the upper-most layer or a world, then it may be the surface pressure.
build_slices (bool = True) – If True, method will find the pressure at each slice of the physical object.
called_from_burnman (bool = False) – Set to True if called from a burnman layer/world.
TidalPy.Extending.burnman.burnman_world module
- class TidalPy.Extending.burnman.burnman_world.BurnManWorld[source]
Bases:
LayeredWorld- Tidal world_types that have layers whose state properties are initialized by user-provided equations of state. These
calculations are done by the Burnman package.
See also
ParentTidalPy.structures.world_types.LayeredWorld
- property bm_layers
- property bm_world
- reinit(initial_init: bool = False, reinit_geometry: bool = True, setup_simple_tides: bool = False, reinit_layers: bool = True)[source]
Initialize or Reinitialize the world based on changes to its configurations.
- This must be called at least once before an instance can be used. The constructor will automatically make an
initial call to reinit unless told to not to.
- Parameters:
initial_init (bool = False) – Must be set to True if this is the first time this function has been called.
reinit_geometry (bool = True) – If True, the initializer will automatically call the set_geometry() method.
set_by_burnman (bool = True) – Set to True if called from a burnman world.
setup_simple_tides (bool = True) – Set to True if a global CPL/CTL tidal calculation is desired.
reinit_layers (bool = True) – If True, calls to the world’s layers’ reinit() method.
- world_class = 'burnman'
TidalPy.Extending.burnman.conversion module
Common conversions between TidalPy and BurnMan