User routines

Routines to adapt Notus to users specificities. More...

Topics
	User fields
	Define custom fields
	User variables
	Define custom variables

Namespaces
module	mod_set_grad_div_coef
	User coefficient of Grad Div term of Navier-Stokes equations.
module	mod_user_boundary_conditions
	User boundary conditions.
module	mod_user_initial_conditions
	User initial conditions.
module	mod_user_linear_term
	User linear terms.
module	mod_user_navier_grad_div_coef
	User coefficient of Grad Div term of Navier-Stokes equations.
module	mod_user_prepare_energy
	User energy equation preparation subroutine.
module	mod_user_prepare_navier
	User Navier-Stokes equations preparation subroutine.
module	mod_user_prepare_phase_advection
	User phase advection equations preparation subroutine.
module	mod_user_prepare_species_transport
	User species transport equations preparation subroutine.
module	mod_user_pressure_update
	User pressure update.
module	mod_user_solve_equations
	Solve user equations. Called once per time iteration.
module	mod_user_source_term
	User source terms.

Functions
subroutine	mod_user_compute_material_properties::user_compute_material_properties ()
	Compute user physical properties fields.
subroutine	mod_initialize_user_fields_and_variables::initialize_user_fields_and_variables ()
	Initialize user fields and variables.
subroutine	mod_user_post_process::user_post_process ()
	Post process user routine.
subroutine	mod_user_reference_solution::user_reference_solution ()
	Reference solution user routine.

Detailed Description

The user directory provides several template Fortran routines, that allows to add one's own code into Notus. These routines are gathered into the following Fortran files:

• initial_conditions.f90 is used to complete initial conditions provided by the NTS file;
• boundary_conditions.f90 is used to complete boundary conditions provided by the NTS file;
• source_term.f90 is used to add a source term to each equation.
• linear_term.f90 is used to add a linear term to each equation.
• compute_material_properties.f90 is used to manipulate density and viscosity fields values;
• next_iteration.f90 is called at the beginning of each iteration; for example, to provide an explicit velocity field;
• post_process.f90 is called at the end of each iteration; for computing one's particular diagnostics;
• reference_solution.f90 is used to provide one's particular reference solution;
• user_prepare_navier.f90, user_prepare_energy.f90, user_prepare_species_transport.f90 and user_prepare_phase_advection.f90 are called in the time loop before solving each equation. They include calls to user boundary conditions, user source term and user linear term subroutines. Any other user changes can be done in these routines.

Function Documentation

initialize_user_fields_and_variables()

subroutine mod_initialize_user_fields_and_variables::initialize_user_fields_and_variables

This user subroutine helps to initialize user fields defined in user_fields module, as well as user variables defined in user_variables.

This routine is called before the time loop.

user_compute_material_properties()

subroutine mod_user_compute_material_properties::user_compute_material_properties

This routine computes, at user convenience, the physical properties of the fluid defined on mesh cells (density, viscosity, etc.).

Interpolation of properties on other grids are not necessary in this routine. This is done at the end of compute_material_properties routine (and so, this done after the call of this routine) or directly during the discretization process.