(git:27c966b)
Loading...
Searching...
No Matches
averages_types.F
Go to the documentation of this file.
1!--------------------------------------------------------------------------------------------------!
2! CP2K: A general program to perform molecular dynamics simulations !
3! Copyright 2000-2026 CP2K developers group <https://cp2k.org> !
4! !
5! SPDX-License-Identifier: GPL-2.0-or-later !
6!--------------------------------------------------------------------------------------------------!
7
8! **************************************************************************************************
9!> \brief Handles the type to compute averages during an MD
10!> \author Teodoro Laino [tlaino] - 03.2008 - University of Zurich
11! **************************************************************************************************
13 USE cell_types, ONLY: cell_type
14 USE colvar_utils, ONLY: get_clv_force,&
27 USE kinds, ONLY: default_string_length,&
28 dp
30 USE virial_types, ONLY: virial_type
31#include "../base/base_uses.f90"
32
33 IMPLICIT NONE
34
35 PRIVATE
36
37! **************************************************************************************************
39 INTEGER :: itimes_start = -1
40 LOGICAL :: do_averages = .false.
41 TYPE(section_vals_type), POINTER :: averages_section => null()
42 ! Real Scalar Quantities
43 REAL(kind=dp) :: avetemp = 0.0_dp, avepot = 0.0_dp, avekin = 0.0_dp, &
44 avevol = 0.0_dp, aveca = 0.0_dp, avecb = 0.0_dp, avecc = 0.0_dp
45 REAL(kind=dp) :: avetemp_baro = 0.0_dp, avehugoniot = 0.0_dp, avecpu = 0.0_dp
46 REAL(kind=dp) :: aveal = 0.0_dp, avebe = 0.0_dp, avega = 0.0_dp, avepress = 0.0_dp, &
47 avekinc = 0.0_dp, avetempc = 0.0_dp, avepxx = 0.0_dp
48 REAL(kind=dp) :: avetemp_qm = 0.0_dp, avekin_qm = 0.0_dp, econs = 0.0_dp
49 ! Virial
50 TYPE(virial_type), POINTER :: virial => null()
51 ! Colvar
52 REAL(kind=dp), POINTER, DIMENSION(:) :: avecolvar => null()
53 REAL(kind=dp), POINTER, DIMENSION(:) :: avemmatrix => null()
55
56! **************************************************************************************************
57 INTERFACE get_averages
58 MODULE PROCEDURE get_averages_rs, get_averages_rv, get_averages_rm
59 END INTERFACE get_averages
60
61! *** Public subroutines and data types ***
64
65! *** Global parameters ***
66 CHARACTER(len=*), PARAMETER, PRIVATE :: moduleN = 'averages_types'
67
68CONTAINS
69
70! **************************************************************************************************
71!> \brief Creates averages environment
72!> \param averages ...
73!> \param averages_section ...
74!> \param virial_avg ...
75!> \param force_env ...
76!> \author Teodoro Laino [tlaino] - 03.2008 - University of Zurich
77! **************************************************************************************************
78 SUBROUTINE create_averages(averages, averages_section, virial_avg, force_env)
79 TYPE(average_quantities_type), POINTER :: averages
80 TYPE(section_vals_type), POINTER :: averages_section
81 LOGICAL, INTENT(IN), OPTIONAL :: virial_avg
82 TYPE(force_env_type), POINTER :: force_env
83
84 INTEGER :: i, nint
85 LOGICAL :: do_colvars
86
87 ALLOCATE (averages)
88 ! Point to the averages section
89 averages%averages_section => averages_section
90 CALL section_vals_val_get(averages_section, "_SECTION_PARAMETERS_", l_val=averages%do_averages)
91 IF (averages%do_averages) THEN
92 ! Setup Virial if requested
93 IF (PRESENT(virial_avg)) THEN
94 IF (virial_avg) THEN
95 ALLOCATE (averages%virial)
96 END IF
97 END IF
98 CALL section_vals_val_get(averages_section, "AVERAGE_COLVAR", l_val=do_colvars)
99 ! Total number of COLVARs
100 nint = 0
101 IF (do_colvars) nint = number_of_colvar(force_env)
102 ALLOCATE (averages%avecolvar(nint))
103 ALLOCATE (averages%aveMmatrix(nint*nint))
104 DO i = 1, nint
105 averages%avecolvar(i) = 0.0_dp
106 END DO
107 DO i = 1, nint*nint
108 averages%aveMmatrix(i) = 0.0_dp
109 END DO
110 END IF
111 END SUBROUTINE create_averages
112
113! **************************************************************************************************
114!> \brief releases the given averages env
115!> \param averages ...
116!> \author Teodoro Laino [tlaino] - 03.2008 - University of Zurich
117! **************************************************************************************************
118 SUBROUTINE release_averages(averages)
119 TYPE(average_quantities_type), POINTER :: averages
120
121 TYPE(section_vals_type), POINTER :: work_section
122
123 IF (ASSOCIATED(averages)) THEN
124 IF (ASSOCIATED(averages%virial)) DEALLOCATE (averages%virial)
125 IF (ASSOCIATED(averages%avecolvar)) THEN
126 DEALLOCATE (averages%avecolvar)
127 END IF
128 IF (ASSOCIATED(averages%aveMmatrix)) THEN
129 DEALLOCATE (averages%aveMmatrix)
130 END IF
131 ! Removes restart values from the corresponding restart section..
132 work_section => section_vals_get_subs_vals(averages%averages_section, "RESTART_AVERAGES")
133 CALL section_vals_remove_values(work_section)
134 NULLIFY (averages%averages_section)
135 !
136 DEALLOCATE (averages)
137 END IF
138
139 END SUBROUTINE release_averages
140
141! **************************************************************************************************
142!> \brief computes the averages
143!> \param averages ...
144!> \param force_env ...
145!> \param md_ener ...
146!> \param cell ...
147!> \param virial ...
148!> \param pv_scalar ...
149!> \param pv_xx ...
150!> \param used_time ...
151!> \param hugoniot ...
152!> \param abc ...
153!> \param cell_angle ...
154!> \param nat ...
155!> \param itimes ...
156!> \param time ...
157!> \param my_pos ...
158!> \param my_act ...
159!> \author Teodoro Laino [tlaino] - 03.2008 - University of Zurich
160! **************************************************************************************************
161 SUBROUTINE compute_averages(averages, force_env, md_ener, cell, virial, &
162 pv_scalar, pv_xx, used_time, hugoniot, abc, cell_angle, nat, itimes, &
163 time, my_pos, my_act)
164 TYPE(average_quantities_type), POINTER :: averages
165 TYPE(force_env_type), POINTER :: force_env
166 TYPE(md_ener_type), POINTER :: md_ener
167 TYPE(cell_type), POINTER :: cell
168 TYPE(virial_type), POINTER :: virial
169 REAL(kind=dp), INTENT(IN) :: pv_scalar, pv_xx
170 REAL(kind=dp), POINTER :: used_time
171 REAL(kind=dp), INTENT(IN) :: hugoniot
172 REAL(kind=dp), DIMENSION(3), INTENT(IN) :: abc, cell_angle
173 INTEGER, INTENT(IN) :: nat, itimes
174 REAL(kind=dp), INTENT(IN) :: time
175 CHARACTER(LEN=default_string_length), INTENT(IN) :: my_pos, my_act
176
177 CHARACTER(len=*), PARAMETER :: routinen = 'compute_averages'
178
179 CHARACTER(LEN=default_string_length) :: ctmp
180 INTEGER :: delta_t, handle, i, nint, output_unit
181 LOGICAL :: restart_averages
182 REAL(kind=dp) :: start_time
183 REAL(kind=dp), DIMENSION(:), POINTER :: cvalues, mmatrix, tmp
184 TYPE(cp_logger_type), POINTER :: logger
185 TYPE(section_vals_type), POINTER :: restart_section
186
187 CALL timeset(routinen, handle)
188 CALL section_vals_val_get(averages%averages_section, "ACQUISITION_START_TIME", &
189 r_val=start_time)
190 IF (averages%do_averages) THEN
191 NULLIFY (cvalues, mmatrix, logger)
192 logger => cp_get_default_logger()
193 ! Determine the nr. of internal colvar (if any/requested)
194 nint = 0
195 IF (ASSOCIATED(averages%avecolvar)) nint = SIZE(averages%avecolvar)
196
197 ! Evaluate averages if we collected enough statistics (user defined)
198 IF (time >= start_time) THEN
199
200 ! Handling properly the restart
201 IF (averages%itimes_start == -1) THEN
202 restart_section => section_vals_get_subs_vals(averages%averages_section, "RESTART_AVERAGES")
203 CALL section_vals_get(restart_section, explicit=restart_averages)
204 IF (restart_averages) THEN
205 CALL section_vals_val_get(restart_section, "ITIMES_START", i_val=averages%itimes_start)
206 CALL section_vals_val_get(restart_section, "AVECPU", r_val=averages%avecpu)
207 CALL section_vals_val_get(restart_section, "AVEHUGONIOT", r_val=averages%avehugoniot)
208 CALL section_vals_val_get(restart_section, "AVETEMP_BARO", r_val=averages%avetemp_baro)
209 CALL section_vals_val_get(restart_section, "AVEPOT", r_val=averages%avepot)
210 CALL section_vals_val_get(restart_section, "AVEKIN", r_val=averages%avekin)
211 CALL section_vals_val_get(restart_section, "AVETEMP", r_val=averages%avetemp)
212 CALL section_vals_val_get(restart_section, "AVEKIN_QM", r_val=averages%avekin_qm)
213 CALL section_vals_val_get(restart_section, "AVETEMP_QM", r_val=averages%avetemp_qm)
214 CALL section_vals_val_get(restart_section, "AVEVOL", r_val=averages%avevol)
215 CALL section_vals_val_get(restart_section, "AVECELL_A", r_val=averages%aveca)
216 CALL section_vals_val_get(restart_section, "AVECELL_B", r_val=averages%avecb)
217 CALL section_vals_val_get(restart_section, "AVECELL_C", r_val=averages%avecc)
218 CALL section_vals_val_get(restart_section, "AVEALPHA", r_val=averages%aveal)
219 CALL section_vals_val_get(restart_section, "AVEBETA", r_val=averages%avebe)
220 CALL section_vals_val_get(restart_section, "AVEGAMMA", r_val=averages%avega)
221 CALL section_vals_val_get(restart_section, "AVE_ECONS", r_val=averages%econs)
222 ! Virial
223 IF (virial%pv_availability) THEN
224 CALL section_vals_val_get(restart_section, "AVE_PRESS", r_val=averages%avepress)
225 CALL section_vals_val_get(restart_section, "AVE_PXX", r_val=averages%avepxx)
226 IF (ASSOCIATED(averages%virial)) THEN
227 CALL section_vals_val_get(restart_section, "AVE_PV_TOT", r_vals=tmp)
228 averages%virial%pv_total = reshape(tmp, [3, 3])
229 CALL section_vals_val_get(restart_section, "AVE_PV_VIR", r_vals=tmp)
230 averages%virial%pv_virial = reshape(tmp, [3, 3])
231 CALL section_vals_val_get(restart_section, "AVE_PV_KIN", r_vals=tmp)
232 averages%virial%pv_kinetic = reshape(tmp, [3, 3])
233 CALL section_vals_val_get(restart_section, "AVE_PV_CNSTR", r_vals=tmp)
234 averages%virial%pv_constraint = reshape(tmp, [3, 3])
235 CALL section_vals_val_get(restart_section, "AVE_PV_XC", r_vals=tmp)
236 averages%virial%pv_xc = reshape(tmp, [3, 3])
237 CALL section_vals_val_get(restart_section, "AVE_PV_FOCK_4C", r_vals=tmp)
238 averages%virial%pv_fock_4c = reshape(tmp, [3, 3])
239 END IF
240 END IF
241 ! Colvars
242 IF (nint > 0) THEN
243 CALL section_vals_val_get(restart_section, "AVE_COLVARS", r_vals=cvalues)
244 CALL section_vals_val_get(restart_section, "AVE_MMATRIX", r_vals=mmatrix)
245 cpassert(nint == SIZE(cvalues))
246 cpassert(nint*nint == SIZE(mmatrix))
247 averages%avecolvar = cvalues
248 averages%aveMmatrix = mmatrix
249 END IF
250 ELSE
251 averages%itimes_start = itimes
252 END IF
253 END IF
254 delta_t = itimes - averages%itimes_start + 1
255
256 ! Perform averages
257 SELECT CASE (delta_t)
258 CASE (1)
259 averages%avecpu = used_time
260 averages%avehugoniot = hugoniot
261 averages%avetemp_baro = md_ener%temp_baro
262 averages%avepot = md_ener%epot
263 averages%avekin = md_ener%ekin
264 averages%avetemp = md_ener%temp_part
265 averages%avekin_qm = md_ener%ekin_qm
266 averages%avetemp_qm = md_ener%temp_qm
267 averages%avevol = cell%deth
268 averages%aveca = abc(1)
269 averages%avecb = abc(2)
270 averages%avecc = abc(3)
271 averages%aveal = cell_angle(3)
272 averages%avebe = cell_angle(2)
273 averages%avega = cell_angle(1)
274 averages%econs = 0._dp
275 ! Virial
276 IF (virial%pv_availability) THEN
277 averages%avepress = pv_scalar
278 averages%avepxx = pv_xx
279 IF (ASSOCIATED(averages%virial)) THEN
280 averages%virial%pv_total = virial%pv_total
281 averages%virial%pv_virial = virial%pv_virial
282 averages%virial%pv_kinetic = virial%pv_kinetic
283 averages%virial%pv_constraint = virial%pv_constraint
284 averages%virial%pv_xc = virial%pv_xc
285 averages%virial%pv_fock_4c = virial%pv_fock_4c
286 END IF
287 END IF
288 ! Colvars
289 IF (nint > 0) THEN
290 CALL get_clv_force(force_env, nsize_xyz=nat*3, nsize_int=nint, &
291 cvalues=averages%avecolvar, mmatrix=averages%aveMmatrix)
292 END IF
293 CASE DEFAULT
294 CALL get_averages(averages%avecpu, used_time, delta_t)
295 CALL get_averages(averages%avehugoniot, hugoniot, delta_t)
296 CALL get_averages(averages%avetemp_baro, md_ener%temp_baro, delta_t)
297 CALL get_averages(averages%avepot, md_ener%epot, delta_t)
298 CALL get_averages(averages%avekin, md_ener%ekin, delta_t)
299 CALL get_averages(averages%avetemp, md_ener%temp_part, delta_t)
300 CALL get_averages(averages%avekin_qm, md_ener%ekin_qm, delta_t)
301 CALL get_averages(averages%avetemp_qm, md_ener%temp_qm, delta_t)
302 CALL get_averages(averages%avevol, cell%deth, delta_t)
303 CALL get_averages(averages%aveca, abc(1), delta_t)
304 CALL get_averages(averages%avecb, abc(2), delta_t)
305 CALL get_averages(averages%avecc, abc(3), delta_t)
306 CALL get_averages(averages%aveal, cell_angle(3), delta_t)
307 CALL get_averages(averages%avebe, cell_angle(2), delta_t)
308 CALL get_averages(averages%avega, cell_angle(1), delta_t)
309 CALL get_averages(averages%econs, md_ener%delta_cons, delta_t)
310 ! Virial
311 IF (virial%pv_availability) THEN
312 CALL get_averages(averages%avepress, pv_scalar, delta_t)
313 CALL get_averages(averages%avepxx, pv_xx, delta_t)
314 IF (ASSOCIATED(averages%virial)) THEN
315 CALL get_averages(averages%virial%pv_total, virial%pv_total, delta_t)
316 CALL get_averages(averages%virial%pv_virial, virial%pv_virial, delta_t)
317 CALL get_averages(averages%virial%pv_kinetic, virial%pv_kinetic, delta_t)
318 CALL get_averages(averages%virial%pv_constraint, virial%pv_constraint, delta_t)
319 CALL get_averages(averages%virial%pv_xc, virial%pv_xc, delta_t)
320 CALL get_averages(averages%virial%pv_fock_4c, virial%pv_fock_4c, delta_t)
321 END IF
322 END IF
323 ! Colvars
324 IF (nint > 0) THEN
325 ALLOCATE (cvalues(nint))
326 ALLOCATE (mmatrix(nint*nint))
327 CALL get_clv_force(force_env, nsize_xyz=nat*3, nsize_int=nint, cvalues=cvalues, &
328 mmatrix=mmatrix)
329 CALL get_averages(averages%avecolvar, cvalues, delta_t)
330 CALL get_averages(averages%aveMmatrix, mmatrix, delta_t)
331 DEALLOCATE (cvalues)
332 DEALLOCATE (mmatrix)
333 END IF
334 END SELECT
335 END IF
336
337 ! Possibly print averages
338 output_unit = cp_print_key_unit_nr(logger, averages%averages_section, "PRINT_AVERAGES", &
339 extension=".avg", file_position=my_pos, file_action=my_act)
340 IF (output_unit > 0) THEN
341 WRITE (output_unit, fmt='(A15,1X,"=",1X,G15.9," NSTEP #",I15)') &
342 "AVECPU", averages%avecpu, itimes, &
343 "AVEHUGONIOT", averages%avehugoniot, itimes, &
344 "AVETEMP_BARO", averages%avetemp_baro, itimes, &
345 "AVEPOT", averages%avepot, itimes, &
346 "AVEKIN", averages%avekin, itimes, &
347 "AVETEMP", averages%avetemp, itimes, &
348 "AVEKIN_QM", averages%avekin_qm, itimes, &
349 "AVETEMP_QM", averages%avetemp_qm, itimes, &
350 "AVEVOL", averages%avevol, itimes, &
351 "AVECELL_A", averages%aveca, itimes, &
352 "AVECELL_B", averages%avecb, itimes, &
353 "AVECELL_C", averages%avecc, itimes, &
354 "AVEALPHA", averages%aveal, itimes, &
355 "AVEBETA", averages%avebe, itimes, &
356 "AVEGAMMA", averages%avega, itimes, &
357 "AVE_ECONS", averages%econs, itimes
358 ! Print the virial
359 IF (virial%pv_availability) THEN
360 WRITE (output_unit, fmt='(A15,1X,"=",1X,G15.9," NSTEP #",I15)') &
361 "AVE_PRESS", averages%avepress, itimes, &
362 "AVE_PXX", averages%avepxx, itimes
363 IF (ASSOCIATED(averages%virial)) THEN
364 WRITE (output_unit, fmt='(A15,1X,"=",1X,G15.9," NSTEP #",I15)') &
365 "AVE_PV_TOT", averages%virial%pv_total, itimes, &
366 "AVE_PV_VIR", averages%virial%pv_virial, itimes, &
367 "AVE_PV_KIN", averages%virial%pv_kinetic, itimes, &
368 "AVE_PV_CNSTR", averages%virial%pv_constraint, itimes, &
369 "AVE_PV_XC", averages%virial%pv_xc, itimes, &
370 "AVE_PV_FOCK_4C", averages%virial%pv_fock_4c, itimes
371 END IF
372 END IF
373 DO i = 1, nint
374 ctmp = cp_to_string(i)
375 WRITE (output_unit, fmt='(A15,1X,"=",1X,G15.9," NSTEP #",I15)') &
376 trim("AVE_CV-"//adjustl(ctmp)), averages%avecolvar(i), itimes
377 END DO
378 WRITE (output_unit, fmt='(/)')
379 END IF
380 CALL cp_print_key_finished_output(output_unit, logger, averages%averages_section, &
381 "PRINT_AVERAGES")
382 END IF
383 CALL timestop(handle)
384 END SUBROUTINE compute_averages
385
386! **************************************************************************************************
387!> \brief computes the averages - low level for REAL
388!> \param avg ...
389!> \param add ...
390!> \param delta_t ...
391!> \author Teodoro Laino [tlaino] - 03.2008 - University of Zurich
392! **************************************************************************************************
393 SUBROUTINE get_averages_rs(avg, add, delta_t)
394 REAL(KIND=dp), INTENT(INOUT) :: avg
395 REAL(KIND=dp), INTENT(IN) :: add
396 INTEGER, INTENT(IN) :: delta_t
397
398 avg = (avg*real(delta_t - 1, dp) + add)/real(delta_t, dp)
399 END SUBROUTINE get_averages_rs
400
401! **************************************************************************************************
402!> \brief computes the averages - low level for REAL vector
403!> \param avg ...
404!> \param add ...
405!> \param delta_t ...
406!> \author Teodoro Laino [tlaino] - 10.2008 - University of Zurich
407! **************************************************************************************************
408 SUBROUTINE get_averages_rv(avg, add, delta_t)
409 REAL(KIND=dp), DIMENSION(:), INTENT(INOUT) :: avg
410 REAL(KIND=dp), DIMENSION(:), INTENT(IN) :: add
411 INTEGER, INTENT(IN) :: delta_t
412
413 INTEGER :: i
414 LOGICAL :: check
415
416 check = SIZE(avg) == SIZE(add)
417 cpassert(check)
418 DO i = 1, SIZE(avg)
419 avg(i) = (avg(i)*real(delta_t - 1, dp) + add(i))/real(delta_t, dp)
420 END DO
421 END SUBROUTINE get_averages_rv
422
423! **************************************************************************************************
424!> \brief computes the averages - low level for REAL matrix
425!> \param avg ...
426!> \param add ...
427!> \param delta_t ...
428!> \author Teodoro Laino [tlaino] - 10.2008 - University of Zurich
429! **************************************************************************************************
430 SUBROUTINE get_averages_rm(avg, add, delta_t)
431 REAL(KIND=dp), DIMENSION(:, :), INTENT(INOUT) :: avg
432 REAL(KIND=dp), DIMENSION(:, :), INTENT(IN) :: add
433 INTEGER, INTENT(IN) :: delta_t
434
435 INTEGER :: i, j
436 LOGICAL :: check
437
438 check = SIZE(avg, 1) == SIZE(add, 1)
439 cpassert(check)
440 check = SIZE(avg, 2) == SIZE(add, 2)
441 cpassert(check)
442 DO i = 1, SIZE(avg, 2)
443 DO j = 1, SIZE(avg, 1)
444 avg(j, i) = (avg(j, i)*real(delta_t - 1, dp) + add(j, i))/real(delta_t, dp)
445 END DO
446 END DO
447 END SUBROUTINE get_averages_rm
448
449END MODULE averages_types
Handles the type to compute averages during an MD.
subroutine, public create_averages(averages, averages_section, virial_avg, force_env)
Creates averages environment.
subroutine, public compute_averages(averages, force_env, md_ener, cell, virial, pv_scalar, pv_xx, used_time, hugoniot, abc, cell_angle, nat, itimes, time, my_pos, my_act)
computes the averages
subroutine, public release_averages(averages)
releases the given averages env
Handles all functions related to the CELL.
Definition cell_types.F:15
evaluations of colvar for internal coordinates schemes
integer function, public number_of_colvar(force_env, only_intra_colvar, unique)
Gives back the number of colvar defined for a force_eval.
subroutine, public get_clv_force(force_env, forces, coords, nsize_xyz, nsize_int, cvalues, mmatrix)
Computes the forces in the frame of collective variables, and additional also the local metric tensor...
various routines to log and control the output. The idea is that decisions about where to log should ...
type(cp_logger_type) function, pointer, public cp_get_default_logger()
returns the default logger
routines to handle the output, The idea is to remove the decision of wheter to output and what to out...
subroutine, public cp_print_key_finished_output(unit_nr, logger, basis_section, print_key_path, local, ignore_should_output, on_file, mpi_io)
should be called after you finish working with a unit obtained with cp_print_key_unit_nr,...
integer function, public cp_print_key_unit_nr(logger, basis_section, print_key_path, extension, middle_name, local, log_filename, ignore_should_output, file_form, file_position, file_action, file_status, do_backup, on_file, is_new_file, mpi_io, fout, file_access)
...
Interface for the force calculations.
objects that represent the structure of input sections and the data contained in an input section
subroutine, public section_vals_remove_values(section_vals)
removes the values of a repetition of the section
recursive type(section_vals_type) function, pointer, public section_vals_get_subs_vals(section_vals, subsection_name, i_rep_section, can_return_null)
returns the values of the requested subsection
subroutine, public section_vals_get(section_vals, ref_count, n_repetition, n_subs_vals_rep, section, explicit)
returns various attributes about the section_vals
subroutine, public section_vals_val_get(section_vals, keyword_name, i_rep_section, i_rep_val, n_rep_val, val, l_val, i_val, r_val, c_val, l_vals, i_vals, r_vals, c_vals, explicit)
returns the requested value
Defines the basic variable types.
Definition kinds.F:23
integer, parameter, public dp
Definition kinds.F:34
integer, parameter, public default_string_length
Definition kinds.F:57
Split md_ener module from md_environment_type.
Type defining parameters related to the simulation cell.
Definition cell_types.F:60
type of a logger, at the moment it contains just a print level starting at which level it should be l...
wrapper to abstract the force evaluation of the various methods