Problem¶
- class freshkiss3d.Problem¶
- Parameters
simutime (freshkiss3d.SimuTime) – Simulation’s time related variables
triangular_mesh (freshkiss3d.TriangularMesh) – Simulation’s triangular mesh
layer (freshkiss3d.Layer) – Simulation’s vertical discretization
primitives (freshkiss3d.Primitive) – Simulation’s primitives H, U, V and related variables
tracers (list (freshkiss3d.Tracer)) – List of tracers (default: None)
numerical_parameters (dict) – Numerical parameters (default: see the first note below)
physical_parameters (dict) – Physical parameters (default: see the second note below)
lagrangian (freshkiss3d.Lagrangian) – Lagrangian particle tracking variables
slides (list (freshkiss3d.Slide)) – List of slide boundary condition (default: None)
torrential_outs (list (freshkiss3d.TorrentialOut)) – List of torrential_out boundary condition (default: None)
damping_outs (list (freshkiss3d.DampingOut)) – List of DampingOut boundary condition (default: None)
fluvial_flowrates (list (freshkiss3d.FluvialFlowRate)) – List of fluvial_flowrate boundary condition (default: None)
fluvial_heights (list (freshkiss3d.FluvialHeight)) – List of fluvial_height boundary condition (default: None)
vertical_flowrates (list (freshkiss3d.VerticalFlowRate)) – List of vertical_flowrate boundary condition (default: None)
external_effects (dict (External effects)) – Dictionary of external effects and source terms
print_progress (freshkiss3d.Scheduler) – Print progress (default: fk.schedules(count=100))
vtk_writer (freshkiss3d.VTKWriter) – Write solution in VTK files
txt_writer (freshkiss3d.TXTWriter) – Write solution in txt files for selected cells
h5_writer (freshkiss3d.H5Writer) – Write solution in h5 files
analytic_sol (freshkiss3d.AnalyticSol) – Analytic solution (default: None)
custom_funct (dict (Custom functions)) – User defined callables - example: create_figures(problem) (default: None)
custom_funct_scheduler (freshkiss3d.Scheduler) – Call user defined custom_funct (default: None)
- forward()¶
Iterates over one time step
- solve()¶
Solves the problem
Note
The default numerical_parameters dictionary include the following keys and values:
'space_second_order':False, second order space scheme'ipres':False, alternative pressure source terms formulation'cfl_adjuster':0.9, CFL coefficient'beta':0.3333, beta slope limiter coefficient (second order)'velocity_correction':False, velocity corrections in reconstructions (second order)'tracer_correction':True, tracer corrections in reconstructions (second order)'flux_type':1, fluxes with chi1(1), chi1b(2) or chi2(3) kinetic functions'implicit_exchanges':True, implicit scheme for exchanges between layers'implicit_vertical_viscosity':True, implicit scheme for vertical viscosity'implicit_vertical_diffusivity':True, implicit scheme for vertical tracer diffusivity'vertical_velocity_centered_scheme':False, vertical velocity centered scheme
Note
The default physical_parameters dictionary include the following keys and values:
'friction_law':'Navier''friction_coeff':0.0'horizontal_viscosity':0.0'vertical_viscosity':0.0'variable_density':False, variable density'variable_density_model':'boussinesq', variable density model: ‘boussinesq’ or ‘ns-fourier’'user_defined_state_law':False, user defined stat law (freshkiss3d/core/state_laws_user.pyx)'ies1980_default_P0':1., default pressure in bar used in IES1980'ies1980_default_T0':10., default temperature in °C used in IES1980'ies1980_default_S0':0., default salinity in g/L used in IES1980'nsf_diffusion':False, thermal diffusion in NSF'nsf_thermal_conductivity':0.6, thermal conductivity used in NSF diffusion'rho_suspension':1001,
