Mondaic

salvus.flow.collections.wavefield_compression

salvus.flow.collections.wavefield_compression salvus flow collections wavefield_compression

Wavefield compression settings.

Classes

WavefieldCompression

class WavefieldCompression(
    salvus.flow.utils.serialization_helpers.SerializationMixin
):
    def __init__(
        self, forward_wavefield_sampling_interval: salvus._core.types.int_
    ): ...

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.

Configure wavefield compression settings.

Parameters
  • forward_wavefield_sampling_interval salvus._core.types.int_ — Determines the sampling interval of the forward wavefield during the gradient computation. A value of 1 will use every temporal sample and will result in consistent discrete gradients, but also the largest amount of checkpoints and thus the largest amount of memory and disk space. The optimal value is application dependent.
Methods
from_json()
def from_json(d: builtins.dict) -> Any: ...

Recreate the object from a dictionary serialization of its initialization parameters.

Parameters
  • d builtins.dict — Dictionary containing its init parameters and a few other things.
Returns Any
to_json()
def to_json(
    self,
    external_file_hash: types = None,
    timer: types = None,
    log_to_logger: bool = False,
    comm: types = None,
) -> builtins.dict: ...

Serialize the object to a dictionary that can be written to JSON.

Parameters
  • external_file_hash types — 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.
  • timer types — Execution timer.
  • log_to_logger bool — Log timings to the logger.
  • comm types — MPI communicator, if any.
Returns builtins.dict

Used in tutorials