scalar_ic Module Reference

Scalar initial condition.

Data Types
interface	set_scalar_ic

Functions/Subroutines
subroutine	set_scalar_ic_int (s, coef, gs, type, params)
	Set scalar initial condition (builtin) More...
subroutine	set_scalar_ic_usr (s, coef, gs, usr_ic, params)
	Set scalar intial condition (user defined) More...
subroutine	set_scalar_ic_common (s, coef, gs)
	Set scalar initial condition (common) More...
subroutine	set_scalar_ic_uniform (s, ic_value)
	Uniform initial condition. More...
subroutine	set_scalar_ic_point_zone (s, base_value, zone_name, zone_value)
	Point zone initial condition. More...

Function/Subroutine Documentation

set_scalar_ic_common()

subroutine scalar_ic::set_scalar_ic_common ( type(field_t), intent(inout)  s, type(coef_t), intent(in)  coef, type(gs_t), intent(inout)  gs  )

private

Finalize scalar initial condition by distributing the initial condition across elements and multiplying by the coefficient (if any).

Parameters

s	Scalar field.
coef	Coefficient.
gs	Gather-Scatter object.

Definition at line 126 of file scalar_ic.f90.

Here is the call graph for this function:

Here is the caller graph for this function:

set_scalar_ic_int()

subroutine scalar_ic::set_scalar_ic_int ( type(field_t), intent(inout)  s, type(coef_t), intent(in)  coef, type(gs_t), intent(inout)  gs, character(len=*)  type, type(json_file), intent(inout)  params  )

private

Set scalar initial condition using one of the builtin types currently supported:

• uniform.

  Parameters

  s	Scalar field.
  coef	Coefficient.
  gs	Gather-Scatter object.
  type	Type of initial condition.
  params	JSON parameters.

Definition at line 69 of file scalar_ic.f90.

set_scalar_ic_point_zone()

subroutine scalar_ic::set_scalar_ic_point_zone ( type(field_t), intent(inout)  s, real(kind=rp), intent(in)  base_value, character(len=*), intent(in)  zone_name, real(kind=rp), intent(in)  zone_value  )

private

Set scalar initial condition to a uniform value across a point zone.

Parameters

s	Scalar field.
base_value	Base value of the scalar field.
zone_name	Name of the point zone.
zone_value	Desired value of the scalar field in the point zone.

Definition at line 172 of file scalar_ic.f90.

Here is the call graph for this function:

Here is the caller graph for this function:

set_scalar_ic_uniform()

subroutine scalar_ic::set_scalar_ic_uniform ( type(field_t), intent(inout)  s, real(kind=rp), intent(in)  ic_value  )

private

Set scalar initial condition to a uniform value across the domain.

Parameters

s	Scalar field.
ic_value	Desired value of the scalar field.

Definition at line 153 of file scalar_ic.f90.

Here is the call graph for this function:

Here is the caller graph for this function:

set_scalar_ic_usr()

subroutine scalar_ic::set_scalar_ic_usr ( type(field_t), intent(inout)  s, type(coef_t), intent(in)  coef, type(gs_t), intent(inout)  gs, procedure(useric_scalar)  usr_ic, type(json_file), intent(inout)  params  )

private

Set scalar initial condition using a user defined function.

Parameters

s	Scalar field.
coef	Coefficient.
gs	Gather-Scatter object.
usr_ic	User defined initial condition function.
params	JSON parameters.

Definition at line 107 of file scalar_ic.f90.