structvectormodule Module Reference

This module contains the StructVectorModule. More...

Data Types
type	tsstringloctype
	derived type which describes time series string field More...
type	structvectortype
	derived type for generic vector More...

Enumerations
enum

Functions/Subroutines
real(dp) function	sv_read_token (this, token, structarray_col, col, row)
subroutine	sv_add_ts_strloc (this, token, structarray_col, col, row)
class(tsstringloctype) function, pointer	sv_get_ts_strloc (this, idx)
subroutine	sv_clear (this)

Variables
@, public	mtype_undef = 0
	undefined memtype More...
@, public	mtype_int = 1
	int1d column More...
@, public	mtype_dbl = 2
	dbl1d column More...
@, public	mtype_str = 3
	charstr1d column More...
@, public	mtype_intvec = 4
	intvector column More...
@, public	mtype_int2d = 5
	int2d (NCELLDIM) column More...
@, public	mtype_dbl2d = 6
	dbl2d (NAUX/NSEG) column More...

Detailed Description

This module contains a generic type for storing different types of vectors.

Enumeration Type Documentation

anonymous enum

anonymous enum

private

Definition at line 23 of file StructVector.f90.

Function/Subroutine Documentation

sv_add_ts_strloc()

subroutine structvectormodule::sv_add_ts_strloc ( class(structvectortype)  this, character(len=*), intent(in)  token, integer(i4b), intent(in)  structarray_col, integer(i4b), intent(in)  col, integer(i4b), intent(in)  row  )

private

Definition at line 102 of file StructVector.f90.

    class(StructVectorType) :: this
    character(len=*), intent(in) :: token
    integer(I4B), intent(in) :: structarray_col
    integer(I4B), intent(in) :: col
    integer(I4B), intent(in) :: row
    class(TSStringLocType), pointer :: str_field
    class(*), pointer :: obj
    allocate (str_field)
    str_field%structarray_col = structarray_col
    str_field%col = col
    str_field%row = row
    str_field%token = token
    obj => str_field
    call this%ts_strlocs%Add(obj)

sv_clear()

subroutine structvectormodule::sv_clear ( class(structvectortype)  this )

private

Definition at line 138 of file StructVector.f90.

    class(StructVectorType) :: this
    class(TSStringLocType), pointer :: ts_strloc
    integer(I4B) :: n
    do n = 1, this%ts_strlocs%Count()
      ts_strloc => this%get_ts_strloc(n)
      deallocate (ts_strloc)
      nullify (ts_strloc)
    end do
    call this%ts_strlocs%Clear()

sv_get_ts_strloc()

class(tsstringloctype) function, pointer structvectormodule::sv_get_ts_strloc ( class(structvectortype)  this, integer(i4b), intent(in)  idx  )

private

Parameters

[in]

idx

package number

Definition at line 119 of file StructVector.f90.

    class(StructVectorType) :: this
    integer(I4B), intent(in) :: idx !< package number
    class(TSStringLocType), pointer :: res
    class(*), pointer :: obj
    ! initialize res
    res => null()
    ! get the package from the list
    obj => this%ts_strlocs%GetItem(idx)
    if (associated(obj)) then
      select type (obj)
      class is (tsstringloctype)
        res => obj
      end select
    end if

sv_read_token()

real(dp) function structvectormodule::sv_read_token ( class(structvectortype)  this, character(len=*), intent(in)  token, integer(i4b), intent(in)  structarray_col, integer(i4b), intent(in)  col, integer(i4b), intent(in)  row  )

private

Definition at line 83 of file StructVector.f90.

    class(StructVectorType) :: this
    character(len=*), intent(in) :: token
    integer(I4B), intent(in) :: structarray_col
    integer(I4B), intent(in) :: col
    integer(I4B), intent(in) :: row
    real(DP) :: val
    integer(I4B) :: istat
    real(DP) :: r
    ! initialize
    val = dnodata
    read (token, *, iostat=istat) r
    if (istat == 0) then
      val = r
    else
      call this%add_ts_strloc(token, structarray_col, col, row)
    end if

Variable Documentation

mtype_dbl

@, public structvectormodule::mtype_dbl = 2

Definition at line 26 of file StructVector.f90.

    enumerator :: MTYPE_DBL = 2 !< dbl1d column

mtype_dbl2d

@, public structvectormodule::mtype_dbl2d = 6

Definition at line 30 of file StructVector.f90.

    enumerator :: MTYPE_DBL2D = 6 !< dbl2d (NAUX/NSEG) column

mtype_int

@, public structvectormodule::mtype_int = 1

Definition at line 25 of file StructVector.f90.

    enumerator :: MTYPE_INT = 1 !< int1d column

mtype_int2d

@, public structvectormodule::mtype_int2d = 5

Definition at line 29 of file StructVector.f90.

    enumerator :: MTYPE_INT2D = 5 !< int2d (NCELLDIM) column

mtype_intvec

@, public structvectormodule::mtype_intvec = 4

Definition at line 28 of file StructVector.f90.

    enumerator :: MTYPE_INTVEC = 4 !< intvector column

mtype_str

@, public structvectormodule::mtype_str = 3

Definition at line 27 of file StructVector.f90.

    enumerator :: MTYPE_STR = 3 !< charstr1d column

mtype_undef

@, public structvectormodule::mtype_undef = 0

Definition at line 24 of file StructVector.f90.

    enumerator :: MTYPE_UNDEF = 0 !< undefined memtype