| | |
- builtins.object
-
- Domain
- Loop
- Slim3d_equations
class Domain(builtins.object) |
| |
Create the slim3d Domain
|
| |
Methods defined here:
- __init__(self, mesh_file_name, periodic_map_file='', reference_density=1027, gravity=9.81)
- keyword arguments:
* mesh_file_name
path to the mesh file (.msh format). The partitioned mesh will automatically be loaded in multiprocessing
Data descriptors defined here:
- __dict__
- dictionary for instance variables (if defined)
- __weakref__
- list of weak references to the object (if defined)
|
class Loop(builtins.object) |
| |
Temporal solver
|
| |
Methods defined here:
- __init__(self, equations, time_step=3600, export_time_step=3600, ratio_full_export=-1, initial_time='1970-01-01 00:00:00', final_time=0, output_directory='./output', full_export_directory='./full_export')
- Initialize self. See help(type(self)) for accurate signature.
- advance_one_time_step(self)
- check_export(self)
- check_full_export(self)
- check_mass_conservation(self)
- check_sanity(self)
- check_tracer_consistency(self)
- export_elevation(self)
- export_elevation_nc(self)
- export_fields(self)
- export_full(self)
- export_nuh(self)
- export_rho(self)
- export_salinity(self)
- export_salinity_nc(self)
- export_temperature(self)
- export_temperature_nc(self)
- export_uv(self, vect=True)
- export_uv2d(self, vect=True)
- export_uv_nc(self)
- export_vertical_diffusivity(self)
- export_vertical_viscosity(self)
- export_w(self)
- export_z_coordinate(self)
- export_z_nc(self)
- get_time(self)
- loop(self)
- print_iter_info(self)
- restart(self, directory, index)
- set_timer(self)
- setup(self)
- terminate(self)
Data descriptors defined here:
- __dict__
- dictionary for instance variables (if defined)
- __weakref__
- list of weak references to the object (if defined)
|
class Slim3d_equations(builtins.object) |
| |
Create the slim3d Equation
|
| |
Methods defined here:
- __init__(self, Domain, salinity=False, temperature=False)
- Initialize self. See help(type(self)) for accurate signature.
- set_additional_artificial_horizontal_shear(self, additional_shear)
- set_atmospheric_pressure(self, atmPress)
- set_bottom_friction(self, flag, z0B=None, z0S=None)
- set_boundary_coast(self, physical_tags)
- set_boundary_open(self, physical_tags, eta=None, u=None, v=None, salinity=None, temperature=None, flux=None, transport=False)
- set_conservative_ale(self, flag)
- set_coriolis(self, coriolis)
- set_forcing(self, forcing_x, forcing_y)
- Add a momentum source term derived from a gravitational potential in the shallow water equation.
keyword arguments:
* forcing_x
netcdf or .msh file containing the forcing term along the x-axis in the local basis for the whole domain [in ms^-2].
* forcing_y
netcdf or .msh file containing the forcing term along the y-axis in the local basis for the whole domain [in ms^-2].
- set_gotm_option_file(self, f)
- set_horizontal_diffusivity(self, mode, constant=1, factor=0.03, maximum=1000000000.0)
- set_horizontal_viscosity(self, mode, constant=1, factor=0.02, maximum=1000000000.0)
- set_implicit_vertical(self, flag)
- set_initial_elevation(self, elevation)
- set_initial_salinity(self, mode, salinity=None, surface_salinity=0, vertical_gradient=0)
- set_initial_temperature(self, mode, temperature=None, surface_temperature=0, vertical_gradient=0)
- set_lax_friedrichs_factor(self, factor=1.0)
- set_limiter(self, flag)
- set_linear_2d_equations(self, flag)
- set_linear_density(self, mode, constant_coefficient=0, linear_coefficient=0)
- Set the density as a linear function of either salinity, temperature or z coordinate. If this function is not set, density follows Jackett-McDougall
keyword arguments:
* mode
"salinity", "temperature" or "z_coordinate"
* constant_coefficient
value of the salinity, temperature or z coord for which rho = rho_0
* linear_coefficient
linear_coefficient of the function
- set_linear_solver_2d(self, flag)
- set_salinity_boundary_relaxation(self, mode, salinity=None, surface_salinity=0, vertical_gradient=0)
- set_temperature_boundary_relaxation(self, mode, temperature=None, surface_temperature=0, vertical_gradient=0, tau=0, belowBottom=0)
- set_vertical_adaptation(self, tau, uv_factor, rho_factor, minimum_height=1, maximum_height=10000000000.0, background_error=0, resize_factor=10000000000.0, smoothing_factor=1, vertical_gradient_factor=0)
- set_vertical_diffusivity(self, mode, constant_value=1e-05, paca_values=[1e-05, 10])
- set_vertical_viscosity(self, mode, constant_value=1e-05, paca_values=[0.01, 1e-05, 10, 2])
- set_wind_stress(self, mode, wind_x, wind_y, density_air=1.25)
- Add a wind stress term in the shallow water equation.
keyword arguments:
* mode
type of wind forcing
* "speed"
wind speed given in m s^-1. wind_stress will be computed with Smith-Banke formula.
stress = C_D(speed)*density_air*speed
Setting the air density is mandatory
* "stress"
wind stress given in kg m^-1 s^-1. (air density will not be used)
* wind_x
netcdf or .msh file containing the wind term along the x-axis in the local basis
(except for equation on a sphere for which it has to be expressed in the global basis (x,y,z)) for the whole domain.
* wind_y
netcdf or .msh file containing the wind term along the y-axis in the local basis
(except for equation on a sphere for which it has to be expressed in the global basis (x,y,z)) for the whole domain.
* density_air
density of the ambiant air (only necessary for "speed" mode) (default: 1.25 [kg m^-3])
Data descriptors defined here:
- __dict__
- dictionary for instance variables (if defined)
- __weakref__
- list of weak references to the object (if defined)
| |