wall_model Module Reference

Implements wall_model_t.

Data Types
type	allocator_entry
	Called in user modules to add an allocator for custom types. More...
interface	wall_model_allocate
	Wall model factory. Both constructs and initializes the object. More...
interface	wall_model_compute
	Compute wall shear stress. More...
interface	wall_model_finalize
	Finilzation of partial construction, similar to bc_t More...
interface	wall_model_free
	Destructor. More...
interface	wall_model_init
	Common constructor. More...
interface	wall_model_partial_init
	Partial constructor from JSON, meant to work as the first stage of initialization before the finalize call. More...
type	wall_model_t
	Base abstract type for wall-stress models for wall-modelled LES. More...

Functions/Subroutines
subroutine	wall_model_init_base (this, scheme_name, coef, msk, facet, sampler)
	Constructor for the wall_model_t (base) class.
subroutine	wall_model_partial_init_base (this, coef, scheme_name, json)
	Partial initialization based on JSON, prior to knowing the mask and facets.
subroutine	wall_model_finalize_base (this, msk, facet, bc_name, user)
subroutine	wall_model_free_base (this)
	Destructor for the wall_model_t (base) class.
subroutine	wall_model_setup_geometry (this)
	Build wall-node normals independently of the sampling strategy.
subroutine	wall_model_validate_single_sample (this)
subroutine	wall_model_compute_mag_field (this)

Variables
type(allocator_entry), dimension(:), allocatable	wall_model_registry
	Registry of wall model allocators for user-defined types.
integer	wall_model_registry_size = 0
	The size of the wall_model_registry

Function/Subroutine Documentation

wall_model_compute_mag_field()

subroutine wall_model::wall_model_compute_mag_field ( class(wall_model_t), intent(inout)  this )

private

Definition at line 439 of file wall_model.f90.

Here is the call graph for this function:

wall_model_finalize_base()

subroutine wall_model::wall_model_finalize_base ( class(wall_model_t), intent(inout)  this, integer, dimension(0:), intent(in), target  msk, integer, dimension(:), intent(in), target  facet, character(len=*), intent(in), optional  bc_name, type(user_t), intent(in), optional, target  user  )

private

Definition at line 323 of file wall_model.f90.

wall_model_free_base()

subroutine wall_model::wall_model_free_base ( class(wall_model_t), intent(inout)  this )

private

Definition at line 365 of file wall_model.f90.

wall_model_init_base()

subroutine wall_model::wall_model_init_base ( class(wall_model_t), intent(inout)  this, character(len=*)  scheme_name, type(coef_t), intent(in), target  coef, integer, dimension(0:), intent(in), target  msk, integer, dimension(0:), intent(in), target  facet, class(wall_sampler_t), intent(inout), allocatable  sampler  )

private

Parameters

coef	SEM coefficients.
msk	The underlying mask of the boundary condition.
facet,The	underlying facet index list of the boundary condition.
scheme_name	The name of the scheme for which the wall model is used.
sampler	Configured sampling strategy; ownership is transferred.

Definition at line 269 of file wall_model.f90.

wall_model_partial_init_base()

subroutine wall_model::wall_model_partial_init_base ( class(wall_model_t), intent(inout)  this, type(coef_t), intent(in), target  coef, character(len=*), intent(in)  scheme_name, type(json_file), intent(inout)  json  )

private

Parameters

coef	SEM coefficients.
The	name of the scheme for which the wall model is used.
json	A dictionary with parameters.

Definition at line 301 of file wall_model.f90.

Here is the call graph for this function:

wall_model_setup_geometry()

subroutine wall_model::wall_model_setup_geometry ( class(wall_model_t), intent(inout)  this )

private

Definition at line 397 of file wall_model.f90.

Here is the call graph for this function:

wall_model_validate_single_sample()

subroutine wall_model::wall_model_validate_single_sample ( class(wall_model_t), intent(inout)  this )

private

Definition at line 431 of file wall_model.f90.

Variable Documentation

wall_model_registry

type(allocator_entry), dimension(:), allocatable wall_model::wall_model_registry

Definition at line 254 of file wall_model.f90.

wall_model_registry_size

integer wall_model::wall_model_registry_size = 0

private

Definition at line 257 of file wall_model.f90.