Neko 1.99.9
A portable framework for high-order spectral element flow simulations
Loading...
Searching...
No Matches
wall_gll_sampler Module Reference

Implements sampling from GLL nodes at prescribed off-wall indices.

Data Types

type  wall_gll_sampler_t
 Wall sampler implementation for GLL nodes at prescribed off-wall indices. More...
 

Functions/Subroutines

subroutine wall_gll_sampler_init (this, json)
 Partial constructor from JSON.
 
subroutine wall_gll_sampler_init_from_indices (this, indices, output_h)
 Partial constructor from off-wall GLL indices.
 
subroutine wall_gll_sampler_init_from_user (this, n_samples, output_h)
 Partial constructor for user-provided GLL sampling indices.
 
subroutine wall_gll_sampler_init_from_components (this, indices, sample_idx, h, output_h)
 Fully construct a GLL sampler from its resolved components.
 
subroutine wall_gll_sampler_finalize (this, coef, msk, facet, n_x, n_y, n_z, bc_name, user)
 Construct field indices and wall-normal distances for sampling. Completes initialization.
 
subroutine wall_gll_sampler_sample (this, field, values)
 Sample the solution field at the sampling points.
 
subroutine wall_gll_sampler_free (this)
 Destructor.
 

Function/Subroutine Documentation

◆ wall_gll_sampler_finalize()

subroutine wall_gll_sampler::wall_gll_sampler_finalize ( class(wall_gll_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
coefSEM coefficients.
mskMask selecting local wall nodes.
facetFacet index for each selected wall node.
n_xX-component of wall-normal vectors at wall nodes.
n_yY-component of wall-normal vectors at wall nodes.
n_zZ-component of wall-normal vectors at wall nodes.
bc_nameName of the owning boundary condition for user values.
userUser interface providing the GLL-sampling callback.

Definition at line 197 of file wall_gll_sampler.f90.

Here is the call graph for this function:

◆ wall_gll_sampler_free()

subroutine wall_gll_sampler::wall_gll_sampler_free ( class(wall_gll_sampler_t), intent(inout this)
private

Definition at line 319 of file wall_gll_sampler.f90.

◆ wall_gll_sampler_init()

subroutine wall_gll_sampler::wall_gll_sampler_init ( class(wall_gll_sampler_t), intent(inout this,
type(json_file), intent(inout json 
)
Parameters
jsonSampler configuration data.

Definition at line 82 of file wall_gll_sampler.f90.

◆ wall_gll_sampler_init_from_components()

subroutine wall_gll_sampler::wall_gll_sampler_init_from_components ( class(wall_gll_sampler_t), intent(inout this,
integer, dimension(:), intent(in indices,
integer, dimension(:), intent(in sample_idx,
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
indicesOff-wall GLL indices for each sample per wall node.
sample_idxLinear sampled-field indices in sampler ordering.
hWall-normal distances in sampler ordering.
output_hSampling-distance diagnostic output flag.

Definition at line 161 of file wall_gll_sampler.f90.

◆ wall_gll_sampler_init_from_indices()

subroutine wall_gll_sampler::wall_gll_sampler_init_from_indices ( class(wall_gll_sampler_t), intent(inout this,
integer, dimension(:), intent(in indices,
logical, intent(in output_h 
)
private
Parameters
indicesPositive GLL indices, one for each sampling point per wall node.
output_hWhether to write the sampling-distance diagnostic.

Definition at line 122 of file wall_gll_sampler.f90.

◆ wall_gll_sampler_init_from_user()

subroutine wall_gll_sampler::wall_gll_sampler_init_from_user ( class(wall_gll_sampler_t), intent(inout this,
integer, intent(in n_samples,
logical, intent(in output_h 
)
private
Parameters
n_samplesNumber of samples per wall node.
output_hWhether to write the sampling-distance diagnostic.

Definition at line 140 of file wall_gll_sampler.f90.

◆ wall_gll_sampler_sample()

subroutine wall_gll_sampler::wall_gll_sampler_sample ( class(wall_gll_sampler_t), intent(inout this,
type(field_t), intent(inout field,
type(vector_t), intent(inout values 
)
private
Parameters
fieldField to be sampled.
valuesOutput sampled values in sampler ordering.

Definition at line 297 of file wall_gll_sampler.f90.

Here is the call graph for this function: