wall_distance_sampler Module Reference

Implements wall_distance_sampler_t.

Data Types
type	wall_distance_sampler_t
	Implements wall-normal sampling at prescribed physical distances. More...

Functions/Subroutines
subroutine	wall_distance_sampler_init (this, json)
	Partial constructor from JSON.
subroutine	wall_distance_sampler_init_from_distances (this, distances, output_h)
	Partial constructor from physical wall-normal distances.
subroutine	wall_distance_sampler_init_from_user (this, n_samples, output_h)
	Partial constructor for user-provided sampling distances.
subroutine	wall_distance_sampler_init_from_components (this, coef, distances, xyz, h, output_h)
	Fully construct a distance sampler from its resolved components.
subroutine	wall_distance_sampler_finalize (this, coef, msk, facet, n_x, n_y, n_z, bc_name, user)
	Construct sampling locations and initialise global interpolation.
subroutine	wall_distance_sampler_sample (this, field, values)
	Sample a field at the configured physical locations.
subroutine	wall_distance_sampler_free (this)
	Release sampler resources.

Function/Subroutine Documentation

wall_distance_sampler_finalize()

subroutine wall_distance_sampler::wall_distance_sampler_finalize ( class(wall_distance_sampler_t), intent(inout)  this, type(coef_t), intent(in)  coef, integer, dimension(0:), intent(in)  msk, integer, dimension(0:), intent(in)  facet, type(vector_t), intent(in)  n_x, type(vector_t), intent(in)  n_y, type(vector_t), intent(in)  n_z, character(len=*), intent(in), optional  bc_name, type(user_t), intent(in), optional, target  user  )

private

Parameters

coef	SEM coefficients.
msk	Mask selecting local wall nodes.
facet	Facet index for each selected wall node.
n_x	X-component of wall-normal vectors at wall nodes.
n_y	Y-component of wall-normal vectors at wall nodes.
n_z	Z-component of wall-normal vectors at wall nodes.
bc_name	Name of the owning boundary condition for user values.
user	User interface providing the distance-sampling callback.

Definition at line 204 of file wall_distance_sampler.f90.

wall_distance_sampler_free()

subroutine wall_distance_sampler::wall_distance_sampler_free ( class(wall_distance_sampler_t), intent(inout)  this )

private

Definition at line 296 of file wall_distance_sampler.f90.

wall_distance_sampler_init()

subroutine wall_distance_sampler::wall_distance_sampler_init	(	class(wall_distance_sampler_t), intent(inout)	this,
		type(json_file), intent(inout)	json
	)

Parameters

json	Sampler configuration data.

Definition at line 83 of file wall_distance_sampler.f90.

wall_distance_sampler_init_from_components()

subroutine wall_distance_sampler::wall_distance_sampler_init_from_components ( class(wall_distance_sampler_t), intent(inout)  this, type(coef_t), intent(in)  coef, real(kind=rp), dimension(:), intent(in)  distances, real(kind=rp), dimension(:,:), intent(in)  xyz, type(vector_t), intent(in)  h, logical, intent(in)  output_h  )

private

Note

No compatibility checks are performed, input data is assumed to be valid. Checking would require geometric information.

Parameters

coef	SEM coefficients used to construct global interpolation.
distances	Physical distances, one for each sample per wall node.
xyz	Sampling locations with shape (3, n_nodes * n_samples).
h	Wall-normal distances in sampler ordering.
output_h	Sampling-distance diagnostic output flag.

Definition at line 164 of file wall_distance_sampler.f90.

wall_distance_sampler_init_from_distances()

subroutine wall_distance_sampler::wall_distance_sampler_init_from_distances ( class(wall_distance_sampler_t), intent(inout)  this, real(kind=rp), dimension(:), intent(in)  distances, logical, intent(in)  output_h  )

private

Parameters

distances	Positive distances, one for each sampling point per wall node.
output_h	Whether to write the sampling-distance diagnostic.

Definition at line 124 of file wall_distance_sampler.f90.

wall_distance_sampler_init_from_user()

subroutine wall_distance_sampler::wall_distance_sampler_init_from_user ( class(wall_distance_sampler_t), intent(inout)  this, integer, intent(in)  n_samples, logical, intent(in)  output_h  )

private

Parameters

n_samples	Number of samples per wall node.
output_h	Whether to write the sampling-distance diagnostic.

Definition at line 142 of file wall_distance_sampler.f90.

wall_distance_sampler_sample()

subroutine wall_distance_sampler::wall_distance_sampler_sample ( class(wall_distance_sampler_t), intent(inout)  this, type(field_t), intent(inout)  field, type(vector_t), intent(inout)  values  )

private

Parameters

field	Field to be sampled.
values	Output sampled values in sampler ordering.

Definition at line 280 of file wall_distance_sampler.f90.