soca_geom_iter_mod::soca_geom_iter Type Reference

Geometry iterator. More...

Collaboration diagram for soca_geom_iter_mod::soca_geom_iter:

Public Member Functions
procedure	setup => soca_geom_iter_setup
	Setup for the geometry iterator. More...
procedure	clone => soca_geom_iter_clone
	Clone for the geometry iterator from other to self. More...
procedure	equals => soca_geom_iter_equals
	Check for the geometry iterator equality (pointing to same i/j location) More...
procedure	current => soca_geom_iter_current
	Get geometry iterator current lat/lon. More...
procedure	next => soca_geom_iter_next
	Update geometry iterator to next point. More...

Public Attributes
integer	iind = 1
	i index of current grid point More...
integer	jind = 1
	j index of current grid point More...

Private Attributes
type(soca_geom), pointer, private	geom => null()
	Geometry. More...

Related Functions
(Note that these are not member functions.)
subroutine	soca_geom_iter_setup (self, geom, iind, jind)
	Setup for the geometry iterator. More...
subroutine	soca_geom_iter_clone (self, other)
	Clone for the geometry iterator from other to self. More...
subroutine	soca_geom_iter_equals (self, other, equals)
	Check for the geometry iterator equality (pointing to same i/j location) More...
subroutine	soca_geom_iter_current (self, lon, lat)
	Get geometry iterator current lat/lon. More...
subroutine	soca_geom_iter_next (self)
	Update geometry iterator to next point. More...

Detailed Description

Geometry iterator.

When initialized, the iterator points to the first valid local grid cell. Calls to soca_geom_iter::next() moves the iterator forward, and calls to soca_geom_iter::current() retrieves the lat/lon of the current grid cell. The iterator is mainly used by soca_increment_mod::soca_increment::getpoint() and soca_increment_mod::soca_increment::setpoint()

Definition at line 27 of file soca_geom_iter_mod.F90.

Member Function/Subroutine Documentation

clone()

procedure soca_geom_iter_mod::soca_geom_iter::clone

Clone for the geometry iterator from other to self.

See also

soca_geom_iter_clone

Definition at line 39 of file soca_geom_iter_mod.F90.

current()

procedure soca_geom_iter_mod::soca_geom_iter::current

Get geometry iterator current lat/lon.

See also

soca_geom_iter_current

Definition at line 45 of file soca_geom_iter_mod.F90.

equals()

procedure soca_geom_iter_mod::soca_geom_iter::equals

Check for the geometry iterator equality (pointing to same i/j location)

See also

soca_geom_iter_equals

Definition at line 42 of file soca_geom_iter_mod.F90.

next()

procedure soca_geom_iter_mod::soca_geom_iter::next

Update geometry iterator to next point.

See also

soca_geom_iter_next

Definition at line 48 of file soca_geom_iter_mod.F90.

setup()

procedure soca_geom_iter_mod::soca_geom_iter::setup

Setup for the geometry iterator.

See also

soca_geom_iter_setup

Definition at line 36 of file soca_geom_iter_mod.F90.

Friends And Related Function Documentation

soca_geom_iter_clone()

subroutine soca_geom_iter_clone ( class(soca_geom_iter), intent(inout)  self, type(soca_geom_iter), intent(in)  other  )

related

Clone for the geometry iterator from other to self.

Parameters

[in]

other

Other geometry iterator to clone from

Definition at line 81 of file soca_geom_iter_mod.F90.

soca_geom_iter_current()

subroutine soca_geom_iter_current ( class(soca_geom_iter), intent(in)  self, real(kind_real), intent(out)  lon, real(kind_real), intent(out)  lat  )

related

Get geometry iterator current lat/lon.

Exceptions

abor1_ftn

aborts if iterator is out of bounds

Parameters

[out]	lat	Latitude
[out]	lon	Longitude

Definition at line 119 of file soca_geom_iter_mod.F90.

soca_geom_iter_equals()

subroutine soca_geom_iter_equals ( class(soca_geom_iter), intent(in)  self, type(soca_geom_iter), intent(in)  other, integer, intent(out)  equals  )

related

Check for the geometry iterator equality (pointing to same i/j location)

Parameters

[in]	other	Other geometry iterator
[out]	equals	Equality flag

Definition at line 99 of file soca_geom_iter_mod.F90.

soca_geom_iter_next()

subroutine soca_geom_iter_next ( class(soca_geom_iter), intent(inout)  self )

related

Update geometry iterator to next point.

Todo:

skip over masked points

Definition at line 147 of file soca_geom_iter_mod.F90.

soca_geom_iter_setup()

subroutine soca_geom_iter_setup ( class(soca_geom_iter), intent(inout)  self, type(soca_geom), intent(in), pointer  geom, integer, intent(in)  iind, integer, intent(in)  jind  )

related

Setup for the geometry iterator.

Parameters

[in]	geom	Pointer to geometry
[in]	jind	starting index

Definition at line 62 of file soca_geom_iter_mod.F90.

Member Data Documentation

geom

type(soca_geom), pointer, private soca_geom_iter_mod::soca_geom_iter::geom => null()

private

Geometry.

Definition at line 28 of file soca_geom_iter_mod.F90.

iind

integer soca_geom_iter_mod::soca_geom_iter::iind = 1

i index of current grid point

Definition at line 30 of file soca_geom_iter_mod.F90.

jind

integer soca_geom_iter_mod::soca_geom_iter::jind = 1

j index of current grid point

Definition at line 31 of file soca_geom_iter_mod.F90.

---

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

• src/soca/GeometryIterator/soca_geom_iter_mod.F90