Probes

Define probes to plot fields on points or lines along time. More...

Namespaces
module	variables_probes
	Define variables associated to probes.

Classes
type	type_probe::t_probe
	Probe. More...
type	type_sample_list::t_sample_list_item
	Item of a sample list. More...
type	type_sample_list::t_sample_list
	List of samples. More...
type	type_sampler::t_sampler
	Sampler. Sample a file on a set of points. More...

Functions
subroutine	type_probe::initialize_probe (probe)
	Initialize a probe structure.
subroutine	type_probe::generate_probe_line (probe, start_point, end_point, nb_points)
	Generate a probe from the coordinates of a line segment.
subroutine	type_probe::evaluate_probe (probe)
	Evaluate the probe and print data to file.
subroutine, public	type_sampler::initialize_sampler (sampler)
	Initialize a sampler. The points of the sampler must be defined prior to call this routine.
subroutine, public	type_sampler::initialize_samples (sampler, samples)
	Initialize an array of samples from a sampler.
subroutine, public	type_sampler::sample_field_cell (sampler, field, samples)
	Sample a field defined on cells.
subroutine, public	type_sampler::sample_field_face_u (sampler, field, samples)
	Sample a field defined on faces in direction _u.
subroutine, public	type_sampler::sample_field_face_v (sampler, field, samples)
	Sample a field defined on faces in direction _v.
subroutine, public	type_sampler::sample_field_face_w (sampler, field, samples)
	Sample a field defined on faces in direction _w.

Detailed Description

Function Documentation

evaluate_probe()

subroutine type_probe::evaluate_probe

(

type(t_probe), intent(inout)

probe

)

Parameters

[in,out]

probe

Probe point or line

generate_probe_line()

subroutine type_probe::generate_probe_line	(	type(t_probe), intent(inout)	probe,
		double precision, dimension(:), intent(in)	start_point,
		double precision, dimension(:), intent(in)	end_point,
		integer, intent(in)	nb_points )

Parameters

[in,out]	probe	Probe point or line
[in]	start_point	First point of the line segment
[in]	end_point	Last point of the line segment
[in]	nb_points	Number of points on the line segment

initialize_probe()

subroutine type_probe::initialize_probe

(

type(t_probe), intent(out)

probe

)

Parameters

[out]

probe

Probe point or line

initialize_sampler()

subroutine, public type_sampler::initialize_sampler

(

type(t_sampler), intent(inout)

sampler

)

Parameters

[in,out]

sampler

Sampler

initialize_samples()

subroutine, public type_sampler::initialize_samples	(	type(t_sampler), intent(in)	sampler,
		double precision, dimension(:), intent(out), allocatable	samples )

Parameters

[in]	sampler	Sampler
[out]	samples	Array of samples

sample_field_cell()

subroutine, public type_sampler::sample_field_cell	(	class(t_sampler), intent(in)	sampler,
		double precision, dimension(:,:,:), intent(in)	field,
		double precision, dimension(:), intent(out)	samples )

Parameters

[in]	sampler	Sampler
[in]	field	Field defined on cells
[out]	samples	Array of samples

sample_field_face_u()

subroutine, public type_sampler::sample_field_face_u	(	class(t_sampler), intent(in)	sampler,
		type(t_face_field), intent(in)	field,
		double precision, dimension(:), intent(out)	samples )

Parameters

[in]	sampler	Sampler
[in]	field	Field defined on faces
[out]	samples	Array of samples

sample_field_face_v()

subroutine, public type_sampler::sample_field_face_v	(	class(t_sampler), intent(in)	sampler,
		type(t_face_field), intent(in)	field,
		double precision, dimension(:), intent(out)	samples )

Parameters

[in]	sampler	Sampler
[in]	field	Field defined on faces
[out]	samples	Array of samples

sample_field_face_w()

subroutine, public type_sampler::sample_field_face_w	(	class(t_sampler), intent(in)	sampler,
		type(t_face_field), intent(in)	field,
		double precision, dimension(:), intent(out)	samples )

Parameters

[in]	sampler	Sampler
[in]	field	Field defined on faces
[out]	samples	Array of samples