richardson Module Reference

Implements richardson_t.

Data Types
type	richardson_t
	Wall model similar to the Monin-Obukhov Similarity Theory for atmospheric boundary layer flows, but which avoids the iterative computation of the Obukhov length, computing the Richardson number directly (Mauritsen, 2007) More...

Functions/Subroutines
subroutine	richardson_init (this, scheme_name, coef, msk, facet, h_index, json)
	Constructor from JSON.
subroutine	richardson_partial_init (this, coef, json)
	Constructor from JSON.
subroutine	richardson_finalize (this, msk, facet)
	Finalize the construction using the mask and facet arrays of the bc.
subroutine	richardson_extract_properties (this)
	Extract the values of rho and mu at the boundary.
subroutine	richardson_init_from_components (this, scheme_name, scalar_name, coef, msk, facet, h_index, kappa, g, pr, z0, z0h_in, bc_type, bc_value)
	Constructor from components.
subroutine	richardson_free (this)
	Destructor for the richardson_t (base) class.
subroutine	richardson_compute (this, t, tstep)
	Compute the wall shear stress.
subroutine	richardson_log_diagnostics (ri_b, l_ob, utau, magu, ti, ts, q, n_nodes, bc_value)

Function/Subroutine Documentation

richardson_compute()

subroutine richardson::richardson_compute ( class(richardson_t), intent(inout)  this, real(kind=rp), intent(in)  t, integer, intent(in)  tstep  )

private

Parameters

t	The time value.
tstep	The time iteration.

Definition at line 451 of file richardson.f90.

Here is the call graph for this function:

richardson_extract_properties()

subroutine richardson::richardson_extract_properties ( class(richardson_t), intent(inout)  this )

private

Definition at line 301 of file richardson.f90.

Here is the call graph for this function:

richardson_finalize()

subroutine richardson::richardson_finalize ( class(richardson_t), intent(inout)  this, integer, dimension(:), intent(in)  msk, integer, dimension(:), intent(in)  facet  )

private

Parameters

msk	The boundary mask.
facet	The boundary facets.

Definition at line 229 of file richardson.f90.

richardson_free()

subroutine richardson::richardson_free ( class(richardson_t), intent(inout)  this )

private

Definition at line 402 of file richardson.f90.

Here is the call graph for this function:

richardson_init()

subroutine richardson::richardson_init	(	class(richardson_t), intent(inout)	this,
		character(len=*), intent(in)	scheme_name,
		type(coef_t), intent(in)	coef,
		integer, dimension(:), intent(in)	msk,
		integer, dimension(:), intent(in)	facet,
		integer, intent(in)	h_index,
		type(json_file), intent(inout)	json
	)

Parameters

scheme_name	The name of the scheme for which the wall model is used.
coef	SEM coefficients.
msk	The boundary mask.
facet	The boundary facets.
h_index	The off-wall index of the sampling cell.
json	A dictionary with parameters.

Definition at line 116 of file richardson.f90.

richardson_init_from_components()

subroutine richardson::richardson_init_from_components ( class(richardson_t), intent(inout)  this, character(len=*), intent(in)  scheme_name, character(len=*), intent(in)  scalar_name, type(coef_t), intent(in)  coef, integer, dimension(:), intent(in)  msk, integer, dimension(:), intent(in)  facet, integer, intent(in)  h_index, real(kind=rp), intent(in)  kappa, real(kind=rp), dimension(3), intent(in)  g, real(kind=rp), intent(in)  pr, real(kind=rp), intent(in)  z0, real(kind=rp), intent(in)  z0h_in, character(len=*), intent(in)  bc_type, real(kind=rp), intent(in)  bc_value  )

private

Parameters

scheme_name	The name of the scheme for which the wall model is used.
coef	SEM coefficients.
msk	The boundary mask.
facet	The boundary facets.
h_index	The off-wall index of the sampling cell.
kappa	The von Karman coefficient.
g	The gravity vector.
z0	The roughness height.
z0h_in	The thermal roughness height. If negative, set automatically from Zilitinkevich, 1995.
bc_type	The type of bc set for temperature in the case file.
scalar_name	The name of the scalar field (temperature) for Richardson WM.
bc_value	The heat flux at the surface boundary condition.

Check magnitude of g

Check alignment across all nodes (handling hills/slopes)

Check sampling height

Definition at line 330 of file richardson.f90.

Here is the call graph for this function:

richardson_log_diagnostics()

subroutine richardson::richardson_log_diagnostics ( type(vector_t), intent(in)  ri_b, type(vector_t), intent(in)  l_ob, type(vector_t), intent(in)  utau, type(vector_t), intent(in)  magu, type(vector_t), intent(in)  ti, type(vector_t), intent(in)  ts, type(vector_t), intent(in)  q, integer, intent(in)  n_nodes, real(kind=rp), intent(in)  bc_value  )

private

Definition at line 501 of file richardson.f90.

Here is the call graph for this function:

Here is the caller graph for this function:

richardson_partial_init()

subroutine richardson::richardson_partial_init ( class(richardson_t), intent(inout)  this, type(coef_t), intent(in)  coef, type(json_file), intent(inout)  json  )

private

Parameters

coef	SEM coefficients.
json	A dictionary with parameters.

Definition at line 170 of file richardson.f90.