MODFLOW 6 version 6.9.0.dev0
USGS Modular Hydrologic Model
Loading...
Searching...
No Matches
memoryhelpermodule Module Reference

Functions/Subroutines

character(len=lenmempath) function create_mem_path (component, subcomponent, context)
 returns the path to the memory object
character(len=lenmemaddress) function create_mem_address (mem_path, var_name)
 returns the address string of the memory object
subroutine split_mem_address (mem_address, mem_path, var_name, success)
 Split a memory address string into memory path and variable name.
subroutine split_mem_path (mem_path, component, subcomponent)
 Split the memory path into component(s).
character(len=lenmempath) function get_mem_path_context (mem_path)
 Return the context from the memory path.
subroutine strip_context_mem_path (mem_path, mem_path_no_context)
 Remove the context from the memory path.
subroutine mem_check_length (name, max_length, description)
 Generic routine to check the length of (parts of) the memory address.

Variables

character(len=lenmemseparator), parameter mempathseparator = '/'
 used to build up the memory address for the stored variables

Function/Subroutine Documentation

◆ create_mem_address()

character(len=lenmemaddress) function memoryhelpermodule::create_mem_address ( character(len=*), intent(in) mem_path,
character(len=*), intent(in) var_name )

Returns the memory address, i.e. the full path plus name of the stored variable

NB: no need to trim the input parameters

Parameters
[in]mem_pathpath to the memory object
[in]var_namename of the stored variable
Returns
full address string to the memory object

Definition at line 56 of file MemoryHelper.f90.

57 character(len=*), intent(in) :: mem_path !< path to the memory object
58 character(len=*), intent(in) :: var_name !< name of the stored variable
59 character(len=LENMEMADDRESS) :: mem_address !< full address string to the memory object
60
61 call mem_check_length(mem_path, lenmempath, "memory path")
62 call mem_check_length(var_name, lenvarname, "variable")
63
64 mem_address = trim(mem_path)//mempathseparator//trim(var_name)
65
Here is the call graph for this function:
Here is the caller graph for this function:

◆ create_mem_path()

character(len=lenmempath) function memoryhelpermodule::create_mem_path ( character(len=*), intent(in) component,
character(len=*), intent(in), optional subcomponent,
character(len=*), intent(in), optional context )

Returns the path to the location in the memory manager where the variables for this (sub)component are stored, the 'memoryPath'

NB: no need to trim the input parameters

Parameters
[in]componentname of the solution, model, or exchange
[in]subcomponentname of the package (optional)
[in]contextname of the context (optional)
Returns
the memory path

Definition at line 22 of file MemoryHelper.f90.

23 character(len=*), intent(in) :: component !< name of the solution, model, or exchange
24 character(len=*), intent(in), optional :: subcomponent !< name of the package (optional)
25 character(len=*), intent(in), optional :: context !< name of the context (optional)
26 character(len=LENMEMPATH) :: memory_path !< the memory path
27
28 call mem_check_length(component, lencomponentname, "solution/model/exchange")
29
30 if (present(subcomponent)) then
31 call mem_check_length(subcomponent, lencomponentname, "package")
32 end if
33
34 if (present(context)) then
35 call mem_check_length(context, lencontextname, "context")
36 end if
37
38 memory_path = trim(component)
39
40 if (present(subcomponent)) then
41 memory_path = trim(memory_path)//mempathseparator//trim(subcomponent)
42 end if
43
44 if (present(context)) then
45 memory_path = trim(context)//mempathseparator//trim(memory_path)
46 end if
47
Here is the call graph for this function:

◆ get_mem_path_context()

character(len=lenmempath) function memoryhelpermodule::get_mem_path_context ( character(len=*), intent(in) mem_path)

NB: when there is no context in the memory path, a empty character string is returned.

Parameters
[in]mem_pathpath to the memory object
Returns
memory path context

Definition at line 146 of file MemoryHelper.f90.

147 character(len=*), intent(in) :: mem_path !< path to the memory object
148 character(len=LENMEMPATH) :: res !< memory path context
149 ! local
150 integer(I4B) :: idx
151
152 ! initialize the memory path context
153 res = ' '
154
155 if (mem_path(1:2) == '__') then
156 idx = index(mem_path, mempathseparator)
157 if (idx > 0) then
158 res = mem_path(:idx)
159 end if
160 end if
Here is the caller graph for this function:

◆ mem_check_length()

subroutine memoryhelpermodule::mem_check_length ( character(len=*), intent(in) name,
integer(i4b), intent(in) max_length,
character(len=*), intent(in) description )

The string will be trimmed before the measurement.

Warning
{if the length exceeds the maximum, a message is recorded and the program will be stopped}

The description should describe the part of the address that is checked (variable, package, model, solution, exchange name) or the full memory path itself

Parameters
[in]namestring to be checked
[in]max_lengthmaximum length
[in]descriptiona descriptive string

Definition at line 198 of file MemoryHelper.f90.

199 character(len=*), intent(in) :: name !< string to be checked
200 integer(I4B), intent(in) :: max_length !< maximum length
201 character(len=*), intent(in) :: description !< a descriptive string
202
203 if (len(trim(name)) > max_length) then
204 write (errmsg, '(*(G0))') &
205 'Fatal error in Memory Manager, length of ', description, ' must be ', &
206 max_length, ' characters or less: ', name, '(len=', len(trim(name)), ')'
207
208 ! -- store error and stop program execution
209 call store_error(errmsg, terminate=.true.)
210 end if
211
Here is the call graph for this function:
Here is the caller graph for this function:

◆ split_mem_address()

subroutine memoryhelpermodule::split_mem_address ( character(len=*), intent(in) mem_address,
character(len=lenmempath), intent(out) mem_path,
character(len=lenvarname), intent(out) var_name,
logical(lgp), intent(out) success )
Parameters
[in]mem_addressthe full memory address string
[out]mem_paththe memory path
[out]var_namethe variable name
[out]successtrue when successful

Definition at line 70 of file MemoryHelper.f90.

71 character(len=*), intent(in) :: mem_address !< the full memory address string
72 character(len=LENMEMPATH), intent(out) :: mem_path !< the memory path
73 character(len=LENVARNAME), intent(out) :: var_name !< the variable name
74 logical(LGP), intent(out) :: success !< true when successful
75 ! local
76 integer(I4B) :: idx
77
78 idx = index(mem_address, mempathseparator, back=.true.)
79
80 ! if no separator, or it's at the end of the string,
81 ! the memory address is not valid:
82 if (idx < 1 .or. idx == len(mem_address)) then
83 success = .false.
84 mem_path = ''
85 var_name = ''
86 else
87 success = .true.
88 mem_path = mem_address(:idx - 1)
89 var_name = mem_address(idx + 1:)
90 end if
91
92 ! remove context specifier if prepended to mempath
93 !if (success) then
94 ! idx = index(mem_path, memPathSeparator, back=.true.)
95 ! if (idx > 0 .and. mem_path(1:2) == '__') then
96 ! mem_path = mem_path(idx + 1:)
97 ! end if
98 !end if
99
Here is the caller graph for this function:

◆ split_mem_path()

subroutine memoryhelpermodule::split_mem_path ( character(len=*), intent(in) mem_path,
character(len=lencomponentname), intent(out) component,
character(len=lencomponentname), intent(out) subcomponent )

NB: when there is no subcomponent in the path, the value for

subcomponent is set to an empty string.
Parameters
[in]mem_pathpath to the memory object
[out]componentname of the component (solution, model, exchange)
[out]subcomponentname of the subcomponent (package)

Definition at line 107 of file MemoryHelper.f90.

108 character(len=*), intent(in) :: mem_path !< path to the memory object
109 character(len=LENCOMPONENTNAME), intent(out) :: component !< name of the component (solution, model, exchange)
110 character(len=LENCOMPONENTNAME), intent(out) :: subcomponent !< name of the subcomponent (package)
111 ! local
112 character(len=LENMEMPATH) :: local_mem_path
113 integer(I4B) :: idx
114
115 call strip_context_mem_path(mem_path, local_mem_path)
116
117 idx = index(local_mem_path, mempathseparator, back=.true.)
118 ! if the separator is found at the end of the string,
119 ! the path is invalid:
120 if (idx == len_trim(local_mem_path)) then
121 write (errmsg, '(*(G0))') &
122 'Fatal error in Memory Manager, cannot split invalid memory path: ', &
123 mem_path
124
125 ! -- store error and stop program execution
126 call store_error(errmsg, terminate=.true.)
127 end if
128
129 if (idx > 0) then
130 ! when found:
131 component = local_mem_path(:idx - 1)
132 subcomponent = local_mem_path(idx + 1:)
133 else
134 ! when not found, there apparently is no subcomponent:
135 component = local_mem_path(:lencomponentname)
136 subcomponent = ''
137 end if
138
Here is the call graph for this function:
Here is the caller graph for this function:

◆ strip_context_mem_path()

subroutine memoryhelpermodule::strip_context_mem_path ( character(len=*), intent(in) mem_path,
character(len=lenmempath), intent(inout) mem_path_no_context )

NB: when there is no context in the memory path, the original memory path is returned.

Parameters
[in]mem_pathpath to the memory object
[in,out]mem_path_no_contextpath to the memory object without the context

Definition at line 168 of file MemoryHelper.f90.

169 character(len=*), intent(in) :: mem_path !< path to the memory object
170 character(len=LENMEMPATH), intent(inout) :: mem_path_no_context !< path to the memory object without the context
171 ! local
172 integer(I4B) :: idx
173 character(len=LENMEMPATH) :: context
174
175 ! initialize the local mem_path
176 mem_path_no_context = mem_path
177
178 context = get_mem_path_context(mem_path)
179
180 if (len_trim(context) > 0) then
181 idx = len_trim(context)
182 mem_path_no_context = mem_path(idx + 1:)
183 end if
184
Here is the call graph for this function:
Here is the caller graph for this function:

Variable Documentation

◆ mempathseparator

character(len=lenmemseparator), parameter memoryhelpermodule::mempathseparator = '/'

Definition at line 10 of file MemoryHelper.f90.