scratch_registry Module Reference

Defines a registry for storing and requesting temporary fields This can be used when you have a function that will be called often and you don't want to create temporary fields (work arrays) inside it on each call.

Data Types
type	scratch_registry_t

Functions/Subroutines
subroutine	scratch_registry_init (this, dof, size, expansion_size)
	Constructor, optionally taking initial registry and expansion size as argument.
subroutine	scratch_registry_free (this)
	Destructor.
pure integer function	get_nfields (this)
	Get the number of fields stored in the registry.
pure integer function	get_nfields_inuse (this)
pure integer function	get_size (this)
	Get the size of the fields array.
pure integer function	get_expansion_size (this)
	Get the expansion size.
subroutine	expand (this)
subroutine	request_field (this, f, index)
	Get a field from the registry by assigning it to a pointer.
subroutine	relinquish_field_single (this, index)
	Relinquish the use of a field in the registry.
subroutine	relinquish_field_multiple (this, indices)
logical function	get_inuse (this, index)

Variables
type(scratch_registry_t), target, public	neko_scratch_registry
	Global scratch registry.

Function/Subroutine Documentation

expand()

subroutine scratch_registry::expand ( class(scratch_registry_t), intent(inout)  this )

private

Definition at line 179 of file scratch_registry.f90.

get_expansion_size()

pure integer function scratch_registry::get_expansion_size ( class(scratch_registry_t), intent(in)  this )

private

Definition at line 172 of file scratch_registry.f90.

get_inuse()

logical function scratch_registry::get_inuse ( class(scratch_registry_t), intent(inout), target  this, integer, intent(inout)  index  )

private

Parameters

[in,out]

index

The index of the field to check

Definition at line 259 of file scratch_registry.f90.

Here is the call graph for this function:

Here is the caller graph for this function:

get_nfields()

pure integer function scratch_registry::get_nfields ( class(scratch_registry_t), intent(in)  this )

private

Definition at line 146 of file scratch_registry.f90.

get_nfields_inuse()

pure integer function scratch_registry::get_nfields_inuse ( class(scratch_registry_t), intent(in)  this )

private

Definition at line 153 of file scratch_registry.f90.

get_size()

pure integer function scratch_registry::get_size ( class(scratch_registry_t), intent(in)  this )

private

Definition at line 164 of file scratch_registry.f90.

relinquish_field_multiple()

subroutine scratch_registry::relinquish_field_multiple ( class(scratch_registry_t), intent(inout), target  this, integer, dimension(:), intent(inout)  indices  )

private

Parameters

[in,out]

indices

The indices of the field to free

Definition at line 248 of file scratch_registry.f90.

Here is the caller graph for this function:

relinquish_field_single()

subroutine scratch_registry::relinquish_field_single ( class(scratch_registry_t), intent(inout), target  this, integer, intent(inout)  index  )

private

Parameters

[in,out]

index

The index of the field to free

Definition at line 240 of file scratch_registry.f90.

Here is the caller graph for this function:

request_field()

subroutine scratch_registry::request_field ( class(scratch_registry_t), intent(inout), target  this, type(field_t), intent(inout), pointer  f, integer, intent(inout)  index  )

private

Parameters

[in,out]

index

The index of the field in the inuse array

Definition at line 202 of file scratch_registry.f90.

Here is the call graph for this function:

scratch_registry_free()

subroutine scratch_registry::scratch_registry_free ( class(scratch_registry_t), intent(inout)  this )

private

Definition at line 124 of file scratch_registry.f90.

scratch_registry_init()

subroutine scratch_registry::scratch_registry_init ( class(scratch_registry_t), intent(inout)  this, type(dofmap_t), intent(in), target  dof, integer, intent(in), optional  size, integer, intent(in), optional  expansion_size  )

private

Definition at line 90 of file scratch_registry.f90.

Variable Documentation

neko_scratch_registry

type(scratch_registry_t), target, public scratch_registry::neko_scratch_registry

Definition at line 84 of file scratch_registry.f90.