PlateTorques¶

PlateTorques is a class that contains the data and methods to calculate the torques acting on the tectonic plates in global plate reconstructions. This class uses several other classes to calculate the torques, such as the Plates, Slabs, and Mantle classes.

The Plates class is used to store the data and geometries for the tectonic plates in the reconstruction.

The Points class is used to store the data on the points of the reconstruction and to calculate the GPE and mantle drag torques.

The Slabs class is used to store the data on the subduction zones of the reconstruction and to calculate the slab pull and slab bend torques.

class plato.plate_torques.PlateTorques(settings=None, reconstruction=None, rotation_file=None, topology_file=None, polygon_file=None, reconstruction_name=None, ages=None, cases_file=None, cases_sheet='Sheet1', files_dir=None, seafloor_age_grids=None, sediment_grids=None, continental_grids=None, velocity_grids=None, plates=None, points=None, slabs=None, grids=None, globe=None, DEBUG_MODE=False, PARALLEL_MODE=False)[source]¶

Bases: object

PlateTorques class.

Parameters:

settings (plato.settings.Settings) – Settings object (default: None)
reconstruction (gplately.PlateReconstruction) – Reconstruction object (default: None)
rotation_file (str) – filepath to .rot file with rotation poles (default: None)
topology_file (str) – filepath to .gpml file with topologies (default: None)
polygon_file (str) – filepath to .gpml file with polygons (default: None)
reconstruction_name (str) – model name string identifiers for the GPlately DataServer (default: None)
ages (float, int, list, numpy.ndarray) – ages of interest (default: None)
cases_file (str) – filepath to excel file with cases (default: None)
cases_sheet (str) – name of the sheet in the excel file with cases (default: “Sheet1”)
files_dir (str) – directory to store files (default: None)
seafloor_age_grids (dict, xarray.Dataset) – seafloor age grids (default: None)
sediment_grids (dict, xarray.Dataset) – sediment thickness grids (default: None)
continental_grids (dict, xarray.Dataset) – continental crust thickness grids (default: None)
velocity_grids (dict, xarray.Dataset) – velocity grids (default: None)
plates (plato.plates.Plates) – Plates object (default: None)
points (plato.points.Points) – Points object (default: None)
slabs (plato.slabs.Slabs) – Slabs object (default: None)
grids (plato.grids.Grids) – Grids object (default: None)
globe (plato.globe.Globe) – Globe object (default: None)
DEBUG_MODE (bool) – debug mode flag (default: False)
PARALLEL_MODE (bool) – parallel mode flag (default: False)

add_grid(input_grids, variable_name='new_grid', grid_type='seafloor_age', target_variable='z', mask_continents=False, interpolate=True, prefactor=1.0)[source]¶

Function to add a grid to the grids object. This calls the add_grid method in the Grids class.

Parameters:

input_grids (dict, xarray.Dataset) – input grids to add to the grids object
variable_name (str) – name of the variable to add (default: “new_grid”)
grid_type (str) – type of grid to add (default: “seafloor_age”)
target_variable (str) – target variable to use (default: “z”)
mask_continents (bool) – mask continents flag (default: False)
prefactor (float) – prefactor to apply to the grid (default: 1.)

calculate_rms_velocity(ages=None, cases=None, plateIDs=None, PROGRESS_BAR=True)[source]¶

Function to calculate root mean square velocities for plates.

Parameters:

ages (float, int, list, numpy.ndarray) – ages of interest (default: None)
cases (str, list) – cases of interest (default: None)
plateIDs (int, float, list, numpy.ndarray) – plateIDs of interest (default: None)

calculate_net_rotation(ages=None, cases=None, plateIDs=None, PROGRESS_BAR=True, VERSION=1)[source]¶

Function to calculate net rotation of the entire lithosphere. This calls the calculate_net_rotation method in the Globe class.

Parameters:

ages (float, int, list, numpy.ndarray) – ages of interest (default: None)
cases (str, list) – cases of interest (default: None)
plateIDs (int, float, list, numpy.ndarray) – plateIDs of interest (default: None)

remove_net_rotation(ages=None, cases=None, plateIDs=None, NUM_ITERATIONS=3, THRESHOLD=1e-06, PROGRESS_BAR=True, VERSION=1)[source]¶

Function to remove net lithospheric rotation from the motion of plates.

Parameters:

ages (float, int, list, numpy.ndarray) – ages of interest (default: None)
cases (str, list) – cases of interest (default: None)
plateIDs (int, float, list, numpy.ndarray) – plateIDs of interest (default: None)

sample_all(ages=None, cases=None, plateIDs=None, PROGRESS_BAR=True)[source]¶

Function to sample all variables relevant to the plate torques calculation. This calls three methods from the slabs class: sample_seafloor_ages, sample_slab_sediment_thicknesses, and sample_slab_sediment_thicknesses.

Parameters:

ages (float, int, list, numpy.ndarray) – ages of interest (default: None)
cases (str, list) – cases of interest (default: None)
plateIDs (int, float, list, numpy.ndarray) – plateIDs of interest (default: None)

sample_seafloor_ages(ages=None, cases=None, plateIDs=None, ITERATIONS=True, PROGRESS_BAR=True)[source]¶

Function to sample the seafloor ages and other variables (if available). This calls the sample_seafloor_ages method for the Points and Slabs class.

Parameters:

ages (float, int, list, numpy.ndarray) – ages of interest (default: None)
cases (str, list) – cases of interest (default: None)
plateIDs (int, float, list, numpy.ndarray) – plateIDs of interest (default: None)

sample_point_seafloor_ages(ages=None, cases=None, plateIDs=None, PROGRESS_BAR=True)[source]¶

Function to sample the seafloor ages and other variables (if available).

Parameters:

ages (float, int, list, numpy.ndarray) – ages of interest (default: None)
cases (str, list) – cases of interest (default: None)
plateIDs (int, float, list, numpy.ndarray) – plateIDs of interest (default: None)

sample_slab_seafloor_ages(ages=None, cases=None, plateIDs=None, ITERATIONS=True, PROGRESS_BAR=True)[source]¶

Function to sample the seafloor ages and other variables (if available).

Parameters:

ages (float, int, list, numpy.ndarray) – ages of interest (default: None)
cases (str, list) – cases of interest (default: None)
plateIDs (int, float, list, numpy.ndarray) – plateIDs of interest (default: None)

sample_arc_seafloor_ages(ages=None, cases=None, plateIDs=None, PROGRESS_BAR=True)[source]¶

Function to sample the seafloor ages and other variables (if available).

Parameters:

ages (float, int, list, numpy.ndarray) – ages of interest (default: None)
cases (str, list) – cases of interest (default: None)
plateIDs (int, float, list, numpy.ndarray) – plateIDs of interest (default: None)

sample_arc_LAB_depth(ages=None, cases=None, plateIDs=None, PROGRESS_BAR=True)[source]¶

Function to sample the arc LAB depth and other variables (if available).

Parameters:

ages (float, int, list, numpy.ndarray) – ages of interest (default: None)
cases (str, list) – cases of interest (default: None)
plateIDs (int, float, list, numpy.ndarray) – plateIDs of interest (default: None)

sample_slab_sediment_thicknesses(ages=None, cases=None, plateIDs=None, PROGRESS_BAR=True)[source]¶

Function to sample the seafloor ages and other variables (if available).

Parameters:

ages (float, int, list, numpy.ndarray) – ages of interest (default: None)
cases (str, list) – cases of interest (default: None)
plateIDs (int, float, list, numpy.ndarray) – plateIDs of interest (default: None)

calculate_lab_depths(ages=None, cases=None, plateIDs=None, PROGRESS_BAR=True)[source]¶

Function to sample the depth of the lithosphere-asthenosphere boundary (LAB) at points. This calls the sample_lab_depths method in the Points class.

Parameters:

ages (float, int, list, numpy.ndarray) – ages of interest (default: None)
cases (str, list) – cases of interest (default: None)
plateIDs (int, float, list, numpy.ndarray) – plateIDs of interest (default: None)

calculate_all_torques(ages=None, cases=None, plateIDs=None, PROGRESS_BAR=True)[source]¶

Function to calculate all torques.

Parameters:

ages (float, int, list, numpy.ndarray) – ages of interest (default: None)
cases (str, list) – cases of interest (default: None)
plateIDs (int, float, list, numpy.ndarray) – plateIDs of interest (default: None)

calculate_gpe_torque(ages=None, cases=None, plateIDs=None, PROGRESS_BAR=True)[source]¶

Function to calculate the GPE torque.

Parameters:

ages (float, int, list, numpy.ndarray) – ages of interest (default: None)
cases (str, list) – cases of interest (default: None)
plateIDs (int, float, list, numpy.ndarray) – plateIDs of interest (default: None)

calculate_slab_pull_torque(ages=None, cases=None, plateIDs=None, PROGRESS_BAR=True)[source]¶

Function to calculate the slab pull torque.

Parameters:

ages (float, int, list, numpy.ndarray) – ages of interest (default: None)
cases (str, list) – cases of interest (default: None)
plateIDs (int, float, list, numpy.ndarray) – plateIDs of interest (default: None)

calculate_mantle_drag_torque(ages=None, cases=None, plateIDs=None, PROGRESS_BAR=True)[source]¶

Function to calculate the mantle drag torque.

Parameters:

ages (float, int, list, numpy.ndarray) – ages of interest (default: None)
cases (str, list) – cases of interest (default: None)
plateIDs (int, float, list, numpy.ndarray) – plateIDs of interest (default: None)

calculate_slab_suction_torque(ages=None, cases=None, plateIDs=None, PROGRESS_BAR=True)[source]¶

Function to calculate the slab bend torque.

Parameters:

ages (float, int, list, numpy.ndarray) – ages of interest (default: None)
cases (str, list) – cases of interest (default: None)
plateIDs (int, float, list, numpy.ndarray) – plateIDs of interest (default: None)

calculate_slab_bend_torque(ages=None, cases=None, plateIDs=None, PROGRESS_BAR=True)[source]¶

Function to calculate the slab bend torque.

Parameters:

ages (float, int, list, numpy.ndarray) – ages of interest (default: None)
cases (str, list) – cases of interest (default: None)
plateIDs (int, float, list, numpy.ndarray) – plateIDs of interest (default: None)

calculate_driving_torque(ages=None, cases=None, plateIDs=None, PROGRESS_BAR=True)[source]¶

Function to calculate the driving torque.

Parameters:

ages (float, int, list, numpy.ndarray) – ages of interest (default: None)
cases (str, list) – cases of interest (default: None)
plateIDs (int, float, list, numpy.ndarray) – plateIDs of interest (default: None)

calculate_residual_torque(ages=None, cases=None, plateIDs=None, CALCULATE_AT_SLABS=True, CALCULATE_AT_POINTS=True, PROGRESS_BAR=True)[source]¶

Function to calculate the driving torque.

Parameters:

ages (float, int, list, numpy.ndarray) – ages of interest (default: None)
cases (str, list) – cases of interest (default: None)
plateIDs (int, float, list, numpy.ndarray) – plateIDs of interest (default: None)

calculate_residual_force(ages=None, cases=None, plateIDs=None, type='slabs', PROGRESS_BAR=True)[source]¶

Function to calculate the residual forces.

Parameters:

ages (float, int, list, numpy.ndarray) – ages of interest (default: None)
cases (str, list) – cases of interest (default: None)
plateIDs (int, float, list, numpy.ndarray) – plateIDs of interest (default: None)

calculate_synthetic_velocity(ages=None, cases=None, plateIDs=None, PROGRESS_BAR=True, RECONSTRUCTED_CASES=False)[source]¶

Function to compute synthetic velocities.

Parameters:

ages (float, int, list, numpy.ndarray) – ages of interest (default: None)
cases (str, list) – cases of interest (default: None)
plateIDs (int, float, list, numpy.ndarray) – plateIDs of interest (default: None)

rotate_torque(reference_rotations, reference_plates, torque='slab_pull_torque', ages=None, cases=None, plateIDs=None, reference_case=None, PROGRESS_BAR=True)[source]¶

Function to rotate a torque vector stored in another the Plates object to the reference frame of this Plates object.

Parameters:

reference_rotations (pygplates.RotationModel) – reference rotations to use for rotation
reference_plates (dict, pandas.DataFrame) – reference plates to use for rotation
torque (str) – torque to rotate (default: “slab_pull_torque”)
ages (float, int, list, numpy.ndarray) – ages of interest (default: None)
cases (str, list) – cases of interest (default: None)
plateIDs (int, float, list, numpy.ndarray) – plateIDs of interest (default: None)

extract_data_through_time(ages=None, cases=None, plateIDs=None, type='plates', var='residual_torque_mag')[source]¶

Function to extract data through time.

Parameters:

ages (float, int, list, numpy.ndarray) – ages of interest (default: None)
cases (str, list) – cases of interest (default: None)
plateIDs (int, float, list, numpy.ndarray) – plateIDs of interest (default: None)

save_all(ages=None, cases=None, plateIDs=None, file_dir=None, PROGRESS_BAR=True)[source]¶

Function to save all classes within the PlateTorques object.

Parameters:

ages (float, int, list, numpy.ndarray) – ages of interest (default: None)
cases (str, list) – cases of interest (default: None)
plateIDs (int, float, list, numpy.ndarray) – plateIDs of interest (default: None)
file_dir (str) – directory to store files (default: None)
PROGRESS_BAR (bool) – flag to show progress bar (default: True)

save_plates(ages=None, cases=None, plateIDs=None, file_dir=None, PROGRESS_BAR=True)[source]¶

Function to save plates.

Parameters:

ages (float, int, list, numpy.ndarray) – ages of interest (default: None)
cases (str, list) – cases of interest (default: None)
plateIDs (int, float, list, numpy.ndarray) – plateIDs of interest (default: None)
file_dir (str) – directory to store files (default: None)
PROGRESS_BAR (bool) – flag to show progress bar (default: True)

save_points(ages=None, cases=None, plateIDs=None, file_dir=None, PROGRESS_BAR=True)[source]¶

Function to save points.

Parameters:

ages (float, int, list, numpy.ndarray) – ages of interest (default: None)
cases (str, list) – cases of interest (default: None)
plateIDs (int, float, list, numpy.ndarray) – plateIDs of interest (default: None)
file_dir (str) – directory to store files (default: None)
PROGRESS_BAR (bool) – flag to show progress bar (default: True)

save_slabs(ages=None, cases=None, plateIDs=None, file_dir=None, PROGRESS_BAR=True)[source]¶

Function to save slabs.

Parameters:

ages (float, int, list, numpy.ndarray) – ages of interest (default: None)
cases (str, list) – cases of interest (default: None)
plateIDs (int, float, list, numpy.ndarray) – plateIDs of interest (default: None)
file_dir (str) – directory to store files (default: None)
PROGRESS_BAR (bool) – flag to show progress bar (default: True)

save_grids(ages=None, cases=None, plateIDs=None, file_dir=None, PROGRESS_BAR=True)[source]¶

Function to save grids.

Parameters:

ages (float, int, list, numpy.ndarray) – ages of interest (default: None)
cases (str, list) – cases of interest (default: None)
plateIDs (int, float, list, numpy.ndarray) – plateIDs of interest (default: None)
file_dir (str) – directory to store files (default: None)
PROGRESS_BAR (bool) – flag to show progress bar (default: True)

save_globe(cases=None, file_dir=None, PROGRESS_BAR=True)[source]¶

Function to save globe.

Parameters:

ages (float, int, list, numpy.ndarray) – ages of interest (default: None)
cases (str, list) – cases of interest (default: None)
plateIDs (int, float, list, numpy.ndarray) – plateIDs of interest (default: None)
file_dir (str) – directory to store files (default: None)
PROGRESS_BAR (bool) – flag to show progress bar (default: True)

export_all(ages=None, cases=None, plateIDs=None, file_dir=None, PROGRESS_BAR=True)[source]¶

Function to export all classes within the PlateTorques object.

Parameters:

ages (float, int, list, numpy.ndarray) – ages of interest (default: None)
cases (str, list) – cases of interest (default: None)
plateIDs (int, float, list, numpy.ndarray) – plateIDs of interest (default: None)
file_dir (str) – directory to store files (default: None)
PROGRESS_BAR (bool) – flag to show progress bar (default: True)

export_plates(ages=None, cases=None, plateIDs=None, file_dir=None, PROGRESS_BAR=True)[source]¶

Function to export plates.

Parameters:

ages (float, int, list, numpy.ndarray) – ages of interest (default: None)
cases (str, list) – cases of interest (default: None)
plateIDs (int, float, list, numpy.ndarray) – plateIDs of interest (default: None)
file_dir (str) – directory to store files (default: None)
PROGRESS_BAR (bool) – flag to show progress bar (default: True)

export_points(ages=None, cases=None, plateIDs=None, file_dir=None, PROGRESS_BAR=True)[source]¶

Function to export points data to a csv file.

Parameters:

ages (float, int, list, numpy.ndarray) – ages of interest (default: None)
cases (str, list) – cases of interest (default: None)
plateIDs (int, float, list, numpy.ndarray) – plateIDs of interest (default: None)
file_dir (str) – directory to store files (default: None)

export_slabs(ages=None, cases=None, plateIDs=None, file_dir=None, PROGRESS_BAR=True)[source]¶

Function to export slabs data to a csv file.

Parameters:

ages (float, int, list, numpy.ndarray) – ages of interest (default: None)
cases (str, list) – cases of interest (default: None)
plateIDs (int, float, list, numpy.ndarray) – plateIDs of interest (default: None)
file_dir (str) – directory to store files (default: None)
PROGRESS_BAR (bool) – flag to show progress bar (default: True)

export_grids(ages=None, cases=None, file_dir=None, PROGRESS_BAR=True)[source]¶

Function to export grids.

Parameters:

ages (float, int, list, numpy.ndarray) – ages of interest (default: None)
cases (str, list) – cases of interest (default: None)
file_dir (str) – directory to store files (default: None)
PROGRESS_BAR (bool) – flag to show progress bar (default: True)

export_globe(cases=None, file_dir=None, PROGRESS_BAR=True)[source]¶

Function to expprt globe.

Parameters:

cases (str, list) – cases of interest (default: None)
file_dir (str) – directory to store files (default: None)
PROGRESS_BAR (bool) – flag to show progress bar (default: True)