field_probe Type Reference

Detailed Description

Synthetic field diagnostic.

Provides setup and driver for sampling a n-vector at specified locations. Locations are mapped during the setup procedure so that subsequent calls to eval have very low overhead.

Public Member Functions
procedure	eval (self, vals)
	Evalute field at all probe locations.
procedure	setup (self, npts, pts, filename)
	Initialize point list and setup ownership.
procedure	setup_save (self, time)
	Setup history file for repeated saves.

Public Attributes
class(fem_interp), pointer	b => NULL()
	Interpolation operator for field.
integer(i4), dimension(:), pointer	cells => NULL()
	Cell containing point.
integer(i4)	dim = 3
	Dimension of field being sampled.
character(len=oft_path_slen)	filename = ''
	History file name.
type(oft_bin_file)	hist_file
class(oft_mesh), pointer	mesh => NULL()
	Mesh containing field.
integer(i4)	nprobes = 0
	Number of probe locations.
logical	project = .FALSE.
	Project points to mesh boundary.
real(r8), dimension(:,:), pointer	pts => NULL()
	Location of points in space.
real(r8), dimension(:,:), pointer	pts_log => NULL()
	Location of points in logical space.
real(r8)	tol =1.d-8
	Off-mesh tolerance in logical coordinates.

Member Function/Subroutine Documentation

eval()

procedure eval	(	class(field_probe), intent(inout)	self,
		real(r8), dimension(:,:), intent(inout)	vals
	)

Evalute field at all probe locations.

Parameters

[in,out]

vals

Fields at all probe locations [3,npts]

setup()

procedure setup	(	class(field_probe), intent(inout)	self,
		integer(i4), intent(inout)	npts,
		real(r8), dimension(:,:), intent(in), optional	pts,
		character(len=*), intent(in), optional	filename
	)

Initialize point list and setup ownership.

Sampling locations may be set in the code directly, via pts, or loaded from a file, via filename. If filename is specified the number of points read from the file is returned in npts.

Parameters

[in,out]	npts	Number of probes
[in]	pts	Array of probe locations [3,npts] (optional)
[in]	filename	File containing probe locations (optional)

setup_save()

procedure setup_save	(	class(field_probe), intent(inout)	self,
		real(r8), intent(in)	time
	)

Setup history file for repeated saves.

Parameters

[in]

time

Time of signal sample

Member Data Documentation

b

class(fem_interp), pointer b => NULL()

Interpolation operator for field.

cells

integer(i4), dimension(:), pointer cells => NULL()

Cell containing point.

dim

integer(i4) dim = 3

Dimension of field being sampled.

filename

character(len=oft_path_slen) filename = ''

History file name.

hist_file

type(oft_bin_file) hist_file

mesh

class(oft_mesh), pointer mesh => NULL()

Mesh containing field.

nprobes

integer(i4) nprobes = 0

Number of probe locations.

project

logical project = .FALSE.

Project points to mesh boundary.

pts

real(r8), dimension(:,:), pointer pts => NULL()

Location of points in space.

pts_log

real(r8), dimension(:,:), pointer pts_log => NULL()

Location of points in logical space.

tol

real(r8) tol =1.d-8

Off-mesh tolerance in logical coordinates.

---

The documentation for this type was generated from the following file:

• /home/runner/work/OpenFUSIONToolkit/OpenFUSIONToolkit/src/physics/diagnostic.F90