Mondaic Documentation
www.mondaic.com
Mondaic
Version:
No results found.
python_api
/
salvus
/
project
/
configuration
/
bathymetry

salvus.project.configuration.bathymetry

salvus.project.configuration.bathymetry salvus project configuration bathymetry
Bathymetry.

Classes

BathymetryConfiguration

Keeps track of the initial arguments passed to an objects and can later on serialize them to JSON document.
It will only consider whatever is passed in the init.
Create a bathymetry configuration.
A bathymetry configuration is a collection of bathymetry models which will be applied to a given mesh via a simulation configuration. The order in which bathymetry models are applied to a mesh is the order in which they appear in this configuration.
SIGNATURE
class BathymetryConfiguration(
    salvus.flow.utils.serialization_helpers.SerializationMixin
):
    def __init__(self, bathymetry_models: list[str] | str) -> None: ...
ARGUMENTS
Required
bathymetry_models
Type:list[str] | str
Description:
List of bathymetry models to be used.

Properties

  • bathymetry_models(list[str])-Get a list of the bathymetry models in this configuration.

Class Methods

BathymetryConfiguration.from_json()
Recreate the object from a dictionary serialization of its initialization parameters.
SIGNATURE
def from_json(d: builtins.dict) -> Any: ...
ARGUMENTS
Required
d
Type:builtins.dict
Description:
Dictionary containing its init parameters and a few other things.

Methods

BathymetryConfiguration.to_json()
Serialize the object to a dictionary that can be written to JSON.
SIGNATURE
def to_json(
    self,
    external_file_hash: types = None,
    timer: types = None,
    log_to_logger: bool = False,
    comm: types = None,
) -> builtins.dict: ...
ARGUMENTS
Optional
external_file_hash
Type:types
Default value:None
Description:
Hash of any external files associated with this object. Can be passed here in which case it will be stored in a centralized location in the JSON file.
Optional
timer
Type:types
Default value:None
Description:
Execution timer.
Optional
log_to_logger
Type:bool
Default value:False
Description:
Log timings to the logger.
Optional
comm
Type:types
Default value:None
Description:
MPI communicator, if any.

Submodules

cartesian
spherical
Previous
configuration
Next
cartesian
We use cookies to analyze our traffic, but won't track you until explicit consent is given. Using our contact form will create relevant cookies and transmit data to third party services to keep track of your request. Read more about how we use personal information in our Privacy Policy.
PAGE CONTENTS