m_derived_variables Module Reference

This module features subroutines that allow for the derivation of numerous flow variables from the conservative and primitive ones. Currently, the available derived variables include the unadvected volume fraction, specific heat ratio, liquid stiffness, speed of sound, vorticity and the numerical Schlieren function. More...

Functions/Subroutines
subroutine, public	s_initialize_derived_variables_module
	Computation of parameters, allocation procedures, and/or any other tasks needed to properly setup the module.
subroutine, public	s_initialize_derived_variables
	Allocate and open derived variables. Computing FD coefficients.
subroutine, public	s_compute_derived_variables (t_step)
	Writes coherent body information, communication files, and probes.
subroutine	s_derive_acceleration_component (i, q_prim_vf0, q_prim_vf1, q_prim_vf2, q_prim_vf3, q_sf)
	This subroutine receives as inputs the indicator of the component of the acceleration that should be outputted and the primitive variables. From those inputs, it proceeds to calculate values of the desired acceleration component, which are subsequently stored in derived flow quantity storage variable, q_sf.
subroutine	s_derive_center_of_mass (q_vf, c_m)
	This subroutine is used together with the volume fraction model and when called upon, it computes the location of of the center of mass for each fluid from the inputted primitive variables, q_prim_vf. The computed location is then written to a formatted data file by the root process.
subroutine, public	s_finalize_derived_variables_module
	Deallocation procedures for the module.

Variables
Finite-difference coefficients
Finite-difference (fd) coefficients in x-, y- and z-coordinate directions. Note that because sufficient boundary information is available for all the active coordinate directions, the centered family of the finite-difference schemes is used.
real(wp), dimension(:, :), allocatable, public	fd_coeff_x
real(wp), dimension(:, :), allocatable, public	fd_coeff_y
real(wp), dimension(:, :), allocatable, public	fd_coeff_z
real(wp), dimension(:, :, :), allocatable, public	accel_mag
real(wp), dimension(:, :, :), allocatable, public	x_accel
real(wp), dimension(:, :, :), allocatable, public	y_accel
real(wp), dimension(:, :, :), allocatable, public	z_accel

Detailed Description

This module features subroutines that allow for the derivation of numerous flow variables from the conservative and primitive ones. Currently, the available derived variables include the unadvected volume fraction, specific heat ratio, liquid stiffness, speed of sound, vorticity and the numerical Schlieren function.

Function/Subroutine Documentation

s_compute_derived_variables()

subroutine, public m_derived_variables::s_compute_derived_variables

(

integer, intent(in)

t_step

)

Writes coherent body information, communication files, and probes.

Parameters

t_step

Current time-step

Here is the call graph for this function:

Here is the caller graph for this function:

s_derive_acceleration_component()

subroutine m_derived_variables::s_derive_acceleration_component	(	integer, intent(in)	i,
		type(scalar_field), dimension(sys_size), intent(in)	q_prim_vf0,
		type(scalar_field), dimension(sys_size), intent(in)	q_prim_vf1,
		type(scalar_field), dimension(sys_size), intent(in)	q_prim_vf2,
		type(scalar_field), dimension(sys_size), intent(in)	q_prim_vf3,
		real(wp), dimension(0:m, 0:n, 0:p), intent(out)	q_sf )

This subroutine receives as inputs the indicator of the component of the acceleration that should be outputted and the primitive variables. From those inputs, it proceeds to calculate values of the desired acceleration component, which are subsequently stored in derived flow quantity storage variable, q_sf.

Parameters

i	Acceleration component indicator
q_prim_vf0	Primitive variables
q_prim_vf1	Primitive variables
q_prim_vf2	Primitive variables
q_prim_vf3	Primitive variables
q_sf	Acceleration component

Here is the caller graph for this function:

s_derive_center_of_mass()

subroutine m_derived_variables::s_derive_center_of_mass	(	type(scalar_field), dimension(sys_size), intent(in)	q_vf,
		real(wp), dimension(1:num_fluids, 1:5), intent(inout)	c_m )

This subroutine is used together with the volume fraction model and when called upon, it computes the location of of the center of mass for each fluid from the inputted primitive variables, q_prim_vf. The computed location is then written to a formatted data file by the root process.

Parameters

q_prim_vf	Primitive variables
c_m	Mass,x-location,y-location,z-location

Here is the call graph for this function:

Here is the caller graph for this function:

s_finalize_derived_variables_module()

subroutine, public m_derived_variables::s_finalize_derived_variables_module

Deallocation procedures for the module.

Here is the call graph for this function:

Here is the caller graph for this function:

s_initialize_derived_variables()

subroutine, public m_derived_variables::s_initialize_derived_variables

Allocate and open derived variables. Computing FD coefficients.

Here is the call graph for this function:

Here is the caller graph for this function:

s_initialize_derived_variables_module()

subroutine, public m_derived_variables::s_initialize_derived_variables_module

Computation of parameters, allocation procedures, and/or any other tasks needed to properly setup the module.

Here is the caller graph for this function:

Variable Documentation

accel_mag

real(wp), dimension(:, :, :), allocatable, public m_derived_variables::accel_mag

fd_coeff_x

real(wp), dimension(:, :), allocatable, public m_derived_variables::fd_coeff_x

fd_coeff_y

real(wp), dimension(:, :), allocatable, public m_derived_variables::fd_coeff_y

fd_coeff_z

real(wp), dimension(:, :), allocatable, public m_derived_variables::fd_coeff_z

x_accel

real(wp), dimension(:, :, :), allocatable, public m_derived_variables::x_accel

y_accel

real(wp), dimension(:, :, :), allocatable, public m_derived_variables::y_accel

z_accel

real(wp), dimension(:, :, :), allocatable, public m_derived_variables::z_accel