flow_ic Module Reference

Initial flow condition.

Data Types
interface	set_flow_ic

Functions/Subroutines
subroutine	set_flow_ic_int (u, v, w, p, coef, gs, type, params)
	Set initial flow condition (builtin)
subroutine	set_flow_ic_usr (u, v, w, p, coef, gs, user_proc, scheme_name)
	Set initial flow condition (user defined)
subroutine	set_compressible_flow_ic_usr (rho, u, v, w, p, coef, gs, user_proc, scheme_name)
	Set initial flow condition (user defined) for compressible flows.
subroutine	set_flow_ic_common (u, v, w, p, coef, gs)
	Make the initial velocity continuous across elements.
subroutine	set_flow_ic_uniform (u, v, w, uinf)
	Uniform initial condition.
subroutine	set_flow_ic_expression (u, v, w, expr)
	Set the initial condition from one mathematical expression per velocity component.
subroutine	set_flow_ic_blasius (u, v, w, delta, uinf, type)
	Set a Blasius profile as initial condition.
subroutine	set_flow_ic_point_zone (u, v, w, base_value, zone_name, zone_value)
	Set the initial condition of the flow based on a point zone.
subroutine, public	set_flow_ic_fld (u, v, w, p, file_name, interpolate, mesh_file_name, global_interp_subdict)
	Set the initial condition of the flow based on a field. @detail The fields are read from an fld file. If enabled, interpolation is also possible. In that case, the mesh coordinates can be read from another field in the fld field series.

Function/Subroutine Documentation

set_compressible_flow_ic_usr()

subroutine flow_ic::set_compressible_flow_ic_usr ( type(field_t), intent(inout), target  rho, type(field_t), intent(inout), target  u, type(field_t), intent(inout), target  v, type(field_t), intent(inout), target  w, type(field_t), intent(inout), target  p, type(coef_t), intent(in)  coef, type(gs_t), intent(inout)  gs, procedure(user_initial_conditions_intf)  user_proc, character(len=*), intent(in)  scheme_name  )

private

Note

No data is copied between the host and the device. The user routine must leave the values where the backend operates on them, i.e. on the device when running on GPUs.

Definition at line 200 of file flow_ic.f90.

set_flow_ic_blasius()

subroutine flow_ic::set_flow_ic_blasius ( type(field_t), intent(inout)  u, type(field_t), intent(inout)  v, type(field_t), intent(inout)  w, real(kind=rp), intent(in)  delta, real(kind=rp), dimension(3), intent(in)  uinf, character(len=*), intent(in)  type  )

private

Note

currently limited to axis aligned flow

Definition at line 363 of file flow_ic.f90.

Here is the caller graph for this function:

set_flow_ic_common()

subroutine flow_ic::set_flow_ic_common ( type(field_t), intent(inout)  u, type(field_t), intent(inout)  v, type(field_t), intent(inout)  w, type(field_t), intent(inout)  p, type(coef_t), intent(in)  coef, type(gs_t), intent(inout)  gs  )

private

Operates on the device arrays when running on GPUs, so the caller must make sure the values are there.

Definition at line 264 of file flow_ic.f90.

Here is the caller graph for this function:

set_flow_ic_expression()

subroutine flow_ic::set_flow_ic_expression ( type(field_t), intent(inout), target  u, type(field_t), intent(inout), target  v, type(field_t), intent(inout), target  w, character(len=*), dimension(:), intent(in)  expr  )

private

The expressions are evaluated in every GLL point of the mesh, with x, y and z bound to the coordinates of the point. Constants declared under case.constants in the case file can be referred to by name, see the expression module for the full syntax.

Parameters

u	The x-component of the velocity field.
v	The y-component of the velocity field.
w	The z-component of the velocity field.
expr	The expressions, one per velocity component.

Definition at line 321 of file flow_ic.f90.

Here is the caller graph for this function:

set_flow_ic_fld()

subroutine, public flow_ic::set_flow_ic_fld	(	type(field_t), intent(inout), target	u,
		type(field_t), intent(inout), target	v,
		type(field_t), intent(inout), target	w,
		type(field_t), intent(inout), target	p,
		character(len=*), intent(inout)	file_name,
		logical, intent(in)	interpolate,
		character(len=*), intent(inout)	mesh_file_name,
		type(json_file), intent(inout)	global_interp_subdict
	)

Parameters

u	The x-component of the velocity field.
v	The y-component of the velocity field.
w	The z-component of the velocity field.
p	The pressure field.
file_name	The name of the "fld" file series.
interpolate	Flag to indicate wether or not to interpolate the values onto the current mesh.
file_name	If interpolation is enabled the name of the "fld" file containing the mesh coordinates (if they are not in file_name).
global_interp_subdict	If interpolation is enabled, subdict containing the interpolation parameters to use.

Definition at line 489 of file flow_ic.f90.

Here is the caller graph for this function:

set_flow_ic_int()

subroutine flow_ic::set_flow_ic_int ( type(field_t), intent(inout)  u, type(field_t), intent(inout)  v, type(field_t), intent(inout)  w, type(field_t), intent(inout)  p, type(coef_t), intent(in)  coef, type(gs_t), intent(inout)  gs, character(len=*)  type, type(json_file), intent(inout)  params  )

private

Definition at line 79 of file flow_ic.f90.

set_flow_ic_point_zone()

subroutine flow_ic::set_flow_ic_point_zone ( type(field_t), intent(inout)  u, type(field_t), intent(inout)  v, type(field_t), intent(inout)  w, real(kind=rp), dimension(3), intent(in)  base_value, character(len=*), intent(in)  zone_name, real(kind=rp), dimension(:), intent(in)  zone_value  )

private

The initial condition is set to the base value and then the zone is filled with the zone value.

Parameters

u	The x-component of the velocity field.
v	The y-component of the velocity field.
w	The z-component of the velocity field.
base_value	The base value of the initial condition.
zone_name	The name of the point zone.
zone_value	The value of the point zone.

Definition at line 437 of file flow_ic.f90.

Here is the caller graph for this function:

set_flow_ic_uniform()

subroutine flow_ic::set_flow_ic_uniform ( type(field_t), intent(inout)  u, type(field_t), intent(inout)  v, type(field_t), intent(inout)  w, real(kind=rp), dimension(3), intent(in)  uinf  )

private

Definition at line 292 of file flow_ic.f90.

Here is the caller graph for this function:

set_flow_ic_usr()

subroutine flow_ic::set_flow_ic_usr ( type(field_t), intent(inout), target  u, type(field_t), intent(inout), target  v, type(field_t), intent(inout), target  w, type(field_t), intent(inout), target  p, type(coef_t), intent(in)  coef, type(gs_t), intent(inout)  gs, procedure(user_initial_conditions_intf)  user_proc, character(len=*), intent(in)  scheme_name  )

private

Note

No data is copied between the host and the device. The user routine must leave the values where the backend operates on them, i.e. on the device when running on GPUs.

Definition at line 153 of file flow_ic.f90.