m_sim_helpers Module Reference

Simulation helper routines for cell state, CFL calculation, and stability checks. More...

Functions/Subroutines
real(wp) function	f_compute_filtered_dtheta (k, l)
	Computes the modified dtheta for Fourier filtering in azimuthal direction.
subroutine, public	s_compute_cell_state (q_prim_vf, pres, rho, gamma, pi_inf, re, alpha, alpha_rho, vel, vel_sum, qv, j, k, l)
	Computes the mixture coefficients, velocity and pressure of one cell.
subroutine, public	s_compute_stability_from_dt (vel, c, rho, re_l, alpha, alpha_rho, j, k, l, icfl, vcfl, rc, ccfl, tcfl)
	Computes stability criterion for a specified dt.
subroutine, public	s_compute_dt_from_cfl (vel, c, max_dt, rho, re_l, alpha, alpha_rho, j, k, l)
	Computes the candidate dts for a specified CFL number: max_dt(1) from the inviscid, max_dt(2) the viscous, max_dt(3) the capillary, and max_dt(4) the thermal diffusion criterion (huge where the criterion is inactive).

Variables
character(len=4), public	dt_limiter = 'none'
	Criterion currently limiting the adaptive time step (ICFL, VCFL, CCFL, TCFL, the collision cap, or the ramp limiter).
character(len=4), dimension(5), parameter, public	dt_limiter_names = (/'ICFL', 'VCFL', 'CCFL', 'TCFL', 'COLL'/)

Detailed Description

Simulation helper routines for cell state, CFL calculation, and stability checks.

Function/Subroutine Documentation

f_compute_filtered_dtheta()

real(wp) function m_sim_helpers::f_compute_filtered_dtheta	(	integer, intent(in)	k,
		integer, intent(in)	l )

Computes the modified dtheta for Fourier filtering in azimuthal direction.

Definition at line 363 of file m_sim_helpers.fpp.f90.

Here is the caller graph for this function:

s_compute_cell_state()

subroutine, public m_sim_helpers::s_compute_cell_state	(	type(scalar_field), dimension(sys_size), intent(in)	q_prim_vf,
		real(wp), intent(inout)	pres,
		real(wp), intent(inout)	rho,
		real(wp), intent(inout)	gamma,
		real(wp), intent(inout)	pi_inf,
		real(wp), dimension(2), intent(inout)	re,
		real(wp), dimension(num_fluids), intent(inout)	alpha,
		real(wp), dimension(num_fluids), intent(inout)	alpha_rho,
		real(wp), dimension(num_vels), intent(inout)	vel,
		real(wp), intent(inout)	vel_sum,
		real(wp), intent(out)	qv,
		integer, intent(in)	j,
		integer, intent(in)	k,
		integer, intent(in)	l )

Computes the mixture coefficients, velocity and pressure of one cell.

Definition at line 400 of file m_sim_helpers.fpp.f90.

Here is the call graph for this function:

Here is the caller graph for this function:

s_compute_dt_from_cfl()

subroutine, public m_sim_helpers::s_compute_dt_from_cfl	(	real(wp), dimension(num_vels), intent(in)	vel,
		real(wp), intent(in)	c,
		real(wp), dimension(4), intent(out)	max_dt,
		real(wp), intent(in)	rho,
		real(wp), dimension(2), intent(in)	re_l,
		real(wp), dimension(num_fluids), intent(in)	alpha,
		real(wp), dimension(num_fluids), intent(in)	alpha_rho,
		integer, intent(in)	j,
		integer, intent(in)	k,
		integer, intent(in)	l )

Computes the candidate dts for a specified CFL number: max_dt(1) from the inviscid, max_dt(2) the viscous, max_dt(3) the capillary, and max_dt(4) the thermal diffusion criterion (huge where the criterion is inactive).

Definition at line 646 of file m_sim_helpers.fpp.f90.

Here is the call graph for this function:

s_compute_stability_from_dt()

subroutine, public m_sim_helpers::s_compute_stability_from_dt	(	real(wp), dimension(num_vels), intent(in)	vel,
		real(wp), intent(in)	c,
		real(wp), intent(in)	rho,
		real(wp), dimension(2), intent(in)	re_l,
		real(wp), dimension(num_fluids), intent(in)	alpha,
		real(wp), dimension(num_fluids), intent(in)	alpha_rho,
		integer, intent(in)	j,
		integer, intent(in)	k,
		integer, intent(in)	l,
		real(wp), intent(inout)	icfl,
		real(wp), intent(inout)	vcfl,
		real(wp), intent(inout)	rc,
		real(wp), intent(inout)	ccfl,
		real(wp), intent(inout)	tcfl )

Computes stability criterion for a specified dt.

Definition at line 518 of file m_sim_helpers.fpp.f90.

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

dt_limiter

character(len=4), public m_sim_helpers::dt_limiter = 'none'

Criterion currently limiting the adaptive time step (ICFL, VCFL, CCFL, TCFL, the collision cap, or the ramp limiter).

Definition at line 357 of file m_sim_helpers.fpp.f90.

dt_limiter_names

character(len=4), dimension(5), parameter, public m_sim_helpers::dt_limiter_names = (/'ICFL', 'VCFL', 'CCFL', 'TCFL', 'COLL'/)

Definition at line 358 of file m_sim_helpers.fpp.f90.