-
Notifications
You must be signed in to change notification settings - Fork 0
/
array_fields.fpp
5019 lines (4867 loc) · 192 KB
/
array_fields.fpp
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
!
! array_fields.f90
! This file is part of FACTUAL.
!
! Copyright 2016 Christopher MacMackin <cmacmackin@gmail.com>
!
! This program is free software; you can redistribute it and/or modify
! it under the terms of the GNU General Public License as published
! by the Free Software Foundation; either version 3 of the License,
! or (at your option) any later version.
!
! This program is distributed in the hope that it will be useful,
! but WITHOUT ANY WARRANTY; without even the implied warranty of
! MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
! GNU General Public License for more details.
!
! You should have received a copy of the GNU General Public License
! License along with this program; if not, write to the Free Software
! Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
! MA 02110-1301, USA.
!
#:include 'fypp_utils.fpp'
module array_fields_mod
!* Author: Chris MacMackin
! Date: September 2016
! License: GPLv3
!
! Provides abstract extensions of the fileds in [[abstract_fields_mod]]
! which store field data in an array. These fields implement all of the
! operations except for the differentiation. Currently only fields using
! Cartesian coordinates are supported.
!
use iso_fortran_env, only: r8 => real64, stderr => error_unit
use abstract_fields_mod, only: abstract_field, scalar_field, vector_field, &
get_tol
use uniform_fields_mod, only: uniform_scalar_field, uniform_vector_field
use utils_mod, only: is_nan, check_set_from_raw, elements_in_slice
use h5lt, only: hid_t, hsize_t, h5ltmake_dataset_double_f, &
h5ltread_dataset_double_f
implicit none
private
type, extends(scalar_field), abstract, public :: array_scalar_field
!* Author: Chris MacMackin
! Date: September 2016
!
! An abstract data type representing a mathematical field of
! scalar values, with the field contents stored in a 1-D
! array. All of the operators are implemented except for
! differentiation. Currently only fields using Cartesian
! coordinates are supported by the vector and calculus routines.
!
! Note that, when performing an operation on two fields, an error
! will occur if one of the fields is of the incorrect type or if
! the sizes of the fields do not match.
!
! @TODO Add option to interpolate values of one of the fields when
! using a binary operator, if they are not otherwise compatible.
! Similarly, have lower-dimensional fields act as though they are
! uniform on all higher dimensions when being operated on with a
! higher dimensional field.
!
private
integer :: numpoints
!! The number of datapoints used
real(r8), dimension(:), allocatable :: field_data
!! The value of the scalar field at the data-points. Each
!! element represents the value at a different location.
logical :: has_deriv = .false.
!! Whether this field has a derivative being used for automatic
!! differentiation.
real(r8), dimension(:), allocatable :: deriv_data
!! The value of the differential of the scalar field at the
!! data-points. Each element represents the value at a different
!! location.
contains
private
procedure, non_overridable, public :: elements => array_scalar_elements
!! Specifies the number of individual data points present in this field.
procedure, public :: raw_size => array_scalar_raw_size
!! Provides the number of pieces of data needed to represent the
!! field, i.e. the size of the array returned by `raw`.
procedure, public :: raw => array_scalar_raw
!! Returns array of data representing state of field. Can be
!! useful for passing to nonlinear solvers
procedure, public :: set_from_raw => array_scalar_set_from_raw
!! Assigns raw data, such as that produced by
!! [[array_scalar_field:raw]], to the field
procedure(sf_raw_slices), deferred :: raw_slices
!! Returns an array of integers used for getting the correct
!! data for a given raw representation of the field.
procedure :: field_multiply_field => array_scalar_sf_m_sf
!! \({\rm field} \times {\rm field}\)
procedure :: field_multiply_vecfield => array_scalar_sf_m_vf
!! \({\rm field} \times {\rm \vec{field}}\)
procedure, pass(rhs) :: real_multiply_field => array_scalar_r_m_sf
!! \({\rm real} \times {\rm field}\)
procedure, pass(rhs) :: real_array_multiply_field => array_scalar_vr_m_sf
!! \(\vec{\rm real} \times {\rm field}\)
procedure :: field_multiply_real => array_scalar_sf_m_r
!! \({\rm field} \times {\rm real}\)
procedure :: field_multiply_real_array => array_scalar_sf_m_vr
!! \({\rm field} \times \vec{\rm real}\)
procedure :: field_divide_field => array_scalar_sf_d_sf
!! \(\frac{\rm field}{\rm field}\)
procedure, pass(rhs) :: real_divide_field => array_scalar_r_d_sf
!! \(\frac{\rm real}{\rm field}\)
procedure, pass(rhs) :: real_array_divide_field => array_scalar_vr_d_sf
!! \(\frac{\vec{\rm real}}{\rm field}\)
procedure :: field_divide_real => array_scalar_sf_d_r
!! \(\frac{\rm field}{\rm real}\)
procedure :: field_add_field => array_scalar_sf_a_sf
!! \({\rm field} + {\rm field}\)
procedure, pass(rhs) :: real_add_field => array_scalar_r_a_sf
!! \({\rm real} + {\rm field}\)
procedure :: field_add_real => array_scalar_sf_a_r
!! \({\rm field} + {\rm real}\)
procedure :: field_sub_field => array_scalar_sf_s_sf
!! \({\rm field} - {\rm field}\)
procedure, pass(rhs) :: real_sub_field => array_scalar_r_s_sf
!! \({\rm real} - {\rm field}\)
procedure :: field_sub_real => array_scalar_sf_s_r
!! \({\rm field} - {\rm real}\)
procedure :: field_pow_real => array_scalar_sf_p_r
!! \({\rm field}^{\rm real}\)
procedure :: field_pow_real4 => array_scalar_sf_p_r4
!! \({\rm field}^{\rm real}\)
procedure :: field_pow_int => array_scalar_sf_p_i
!! \({\rm field}^{\rm int}\)
#:for FUNC, TEX in UNARY_FUNCTIONS
$:unary_binding(FUNC, TEX, 'array_scalar')
#:endfor
procedure :: minval => array_scalar_minval
!! \(\min({\rm field})\)
procedure :: maxval => array_scalar_maxval
!! \(\max({\rm field})\)
procedure, public :: d_dx => array_scalar_d_dx
!! \(\frac{\partial^n}{\partial x_i^n}({\rm field})\)
procedure :: gradient => array_scalar_gradient
!! \(\nabla {\rm field}\)
procedure :: laplacian => array_scalar_laplacian
!! \(\nabla^2 {\rm field}\)
procedure :: is_equal => array_scalar_is_equal
!! Checks fields are equal within a tolerance
procedure :: assign_field => array_scalar_assign
!! \({\rm field} = {\rm field}\)
procedure, public :: assign_meta_data => array_scalar_assign_meta_data
!! Copies all data other than values stored in field from another
!! field object to this one.
procedure, non_overridable, public :: read_hdf_array => array_scalar_read_hdf
!! Reads the array of field data from an HDF file
procedure, non_overridable, public :: write_hdf_array => array_scalar_write_hdf
!! Writes the array of field data to an HDF file
procedure(sf_meta), deferred :: assign_subtype_meta_data
!! Copies all data stored in a subtype of [[array_scalar_field(type)]]
!! from another field object to this one.
procedure, non_overridable :: check_compatible => array_scalar_compatible
!! Tests whether two fields are suitable for binary operations together
procedure(sf_compatible), deferred :: check_subtype_compatible
!! Tests whether two fields are suitable for binary operations
!! together, checking that any properties of subtypes of
!! [[array_scalar_field(type)]] are compatible.
procedure(sf_scalar_dx), deferred :: array_dx
!! Takes the derivative of the scalar field using a 1-D array of
!! data passed to it.
procedure(sf_array_interp), deferred :: array_interpolate
!! Interpolates a value in the field, using a 1-D array of data
!! passed to it.
procedure, public :: get_element => array_scalar_get_element
!! Returns one of the constituent values of the field, i.e. the
!! field's value at a particular location.
procedure, public :: set_element => array_scalar_set_element
!! Sets one of the constituent values of the field, i.e. the
!! field's value at a particular location.
procedure, public :: set_deriv_element => array_scalar_set_deriv_element
!! Sets one of the constituent values of the field's derivative,
!! i.e. the field's derivative value at a particular location.
procedure, public :: get_boundary => array_scalar_get_bound
!! Returns a field of the same type, containing only the
!! specified ammount of data at the specified boundary.
procedure, public :: set_derivative => array_scalar_set_deriv
!! Sets a derivative value for this field, which gets propagated
!! through operations using automatic differentiation (tangent
!! mode).
procedure, public :: unset_derivative => array_scalar_unset_deriv
!! Removes any derivative value for this field, turning off
!! automatic differentiation.
procedure, public :: get_derivative => array_scalar_get_deriv
!! Provides the derivative value for this field. This was either
!! set by the user or calculated using automatic
!! differentiation. If no derivative information is available
!! for this object then a field of zeros is returned.
procedure, non_overridable :: allocate_deriv => array_scalar_alloc_deriv
!! Decides whether to allocate the array containing the
!! derivative.
procedure, public :: has_derivative => array_scalar_has_deriv
!! Indicates whether the field has a derivative value.
procedure(sf_bound), deferred :: subtype_boundary
!! Performs whatever operations are needed on the subtype to get
!! a boundary field, including returning the slices needed to
!! extract the appropriate data.
procedure, non_overridable :: is_allocated => array_scalar_is_allocated
!! Indicates whether both the array pointer _and_ the array it
!! contains are allocated.
procedure, public :: finalise => array_scalar_finalise
!! Deallocates the contents of the field. The bulk of the
!! field's memory should be deallocated with the `clean_temp`
!! method, but that is unable to deallocate the pointer to the
!! data array--only the array itself. In compilers which support
!! finalisation, this method eliminates the small memory leak
!! from the pointer.
procedure, public :: interpolate => array_scalar_interp
!! Interpolates the value of the field at the specified
!! location.
end type array_scalar_field
interface array_scalar_field
module procedure array_scalar_constructor1
module procedure array_scalar_constructor2
end interface array_scalar_field
abstract interface
function sf_raw_slices(this,exclude_lower_bound,exclude_upper_bound) &
result(slices)
import :: array_scalar_field
class(array_scalar_field), intent(in) :: this
integer, dimension(:), optional, intent(in) :: exclude_lower_bound
!! Specifies how many layers of data points should be excluded
!! from the result at the lower boundary for each
!! dimension. The number in element `n` of the array indicates
!! how many layers of cells at the lower boundary normal to
!! dimension `n` will be ignored. Defaults to 0 for all.
integer, dimension(:), optional, intent(in) :: exclude_upper_bound
!! Specifies how many layers of data points should be excluded
!! from the result at the upper boundary for each
!! dimension. The number in element `n` of the array indicates
!! how many layers of cells at the upper boundary normal to
!! dimension `n` will be ignored. Defaults to 0 for all.
integer, dimension(:,:), allocatable :: slices
!! An array containing array slice data which can be used to
!! construct the raw representation of a field, with the given
!! boundary conditions. The form of the array is
!! ```
!! slices(1,i) = start_index
!! slices(2,i) = end_index
!! slices(3,i) = stride
!! ```
end function sf_raw_slices
subroutine sf_compatible(this,other)
!* Author: Chris MacMackin
! Date: April 2016
!
! Checks whether a field has the same type, boundaries, and
! resolution as this one, making it compatible for binary
! operations. If incompatible, stops program with an error message.
!
import :: array_scalar_field
import :: abstract_field
class(array_scalar_field), intent(in) :: this
class(abstract_field), intent(in) :: other
!! The field being checked against this one
end subroutine sf_compatible
subroutine sf_bound(this,src,boundary,depth,slices)
import :: array_scalar_field
class(array_scalar_field), intent(inout) :: this
class(array_scalar_field), intent(in) :: src
!! The field for which the boundary data is to be provided.
integer, intent(in) :: boundary
!! Specifies which boundary is to be returned. The boundary
!! will be the one normal to dimension of number
!! `abs(boundary)`. If the argument is negative, then the
!! lower boundary is returned. If positive, then the upper
!! boundary is returned.
integer, intent(in) :: depth
!! The number of layers of data-points to return at the
!! specified boundary.
integer, dimension(:,:), allocatable, intent(out) :: slices
!! An array containing array slice data which can be used to
!! construct extract the data for the given field
!! boundary. The form of the array is
!! ```
!! slices(1,i) = start_index
!! slices(2,i) = end_index
!! slices(3,i) = stride
!! ```
end subroutine sf_bound
subroutine sf_meta(this, rhs)
import :: array_scalar_field
import :: abstract_field
class(array_scalar_field), intent(inout) :: this
class(abstract_field), intent(in) :: rhs
!! The field whose metadata (data which are not field vales)
!! is to be copied
end subroutine sf_meta
function sf_scalar_dx(this, data_array, dir, order) result(res)
import :: array_scalar_field
import :: r8
class(array_scalar_field), intent(in) :: this
real(r8), dimension(:), intent(in) :: data_array
!! An array holding the datapoints for this field, identical
!! in layout to that stored the field itself.
integer, intent(in) :: dir
!! Direction in which to differentiate
integer, intent(in), optional :: order
!! Order of the derivative, default = 1
real(r8), dimension(:), allocatable :: res
!! The spatial derivative of order `order` taken in direction `dir`
end function sf_scalar_dx
function sf_array_interp(this, data_array, location) result(val)
import :: array_scalar_field
import :: r8
class(array_scalar_field), intent(in) :: this
real(r8), dimension(:), intent(in) :: data_array
!! An array holding the datapoints for this field, identical
!! in layout to that stored the field itself.
real(r8), dimension(:), intent(in) :: location
!! The location at which to calculate the interpolated value.
real(r8) :: val
!! The spatial derivative of order `order` taken in direction `dir`
end function sf_array_interp
function scalar_init(x) result(scalar)
!! Function used to specify value held by a scalar field at
!! location `x`.
import :: r8
real(r8), dimension(:), intent(in) :: x
!! The position at which this function is evaluated
real(r8) :: scalar
!! The value of the field at this location
end function scalar_init
end interface
type, extends(vector_field), abstract, public :: array_vector_field
!* Author: Chris MacMackin
! Date: September 2016
!
! An abstract data type representing a mathematical field of vector
! values, with the field contents stored in a 1-D array. All of the
! non-calculus operators are implemented.
!
! Note that, when performing an operation on two fields, an error
! will occur if one of the fields is of the incorrect type or if
! the sizes of the fields do not match.
!
! @TODO Add option to interpolate values of one of the fields when
! using a binary operator, if they are not otherwise compatible.
! Similarly, have lower-dimensional fields act as though they are
! uniform on all higher dimensions when being operated on with a
! higher dimensional field.
!
private
integer :: numpoints
!! The number of datapoints used
real(r8), dimension(:,:), allocatable :: field_data
!! The value of the vector field at the data-points. Each row
!! represents a different spatial location, while each column
!! represents a different component of the vector.
integer :: vector_dims = 0
!! The number of vector components
logical :: has_deriv = .false.
!! Whether this field has a derivative being used for automatic
!! differentiation.
real(r8), dimension(:,:), allocatable :: deriv_data
!! The value of the differential of the scalar field at the
!! data-points. Each row represents a different spatial
!! location, while each column represents a different component
!! of the vector.
contains
private
procedure, non_overridable, public :: &
vector_dimensions => array_vector_vector_dimensions
!! Returns dimension of the vectors in the field
procedure, public :: elements => array_vector_elements
!! Specifies the number of individual data points present in this field.
procedure, public :: raw_size => array_vector_raw_size
!! Provides the number of pieces of data needed to represent the
!! field, i.e. the size of the array returned by `raw`.
procedure, public :: raw => array_vector_raw
!! Returns array of data representing state of field. Can be
!! useful for passing to nonlinear solvers.
procedure, public :: set_from_raw => array_vector_set_from_raw
!! Assigns raw data, such as that produced by
!! [[array_vector_field:raw]], to the field
procedure(vf_raw_slices), deferred :: raw_slices
!! Returns an array of integers used for getting the correct
!! data for a given raw representation of the field.
procedure :: field_multiply_field => array_vector_vf_m_sf
!! \({\rm field} \times {\rm field}\)
procedure, pass(rhs) :: real_multiply_field => array_vector_r_m_vf
!! \({\rm real} \times {\rm field}\)
procedure :: field_multiply_real => array_vector_vf_m_r
!! \({\rm field} \times {\rm real}\)
procedure :: field_divide_field => array_vector_vf_d_sf
!! \(\frac{\rm field}{\rm field}\)
procedure :: field_divide_real => array_vector_vf_d_r
!! \(\frac{\rm field}{\rm real}\)
procedure :: field_add_field => array_vector_vf_a_vf
!! \({\rm field} + {\rm field}\)
procedure, pass(rhs) :: real_add_field => array_vector_r_a_vf
!! \({\rm real} + {\rm field}\)
procedure :: field_add_real => array_vector_vf_a_r
!! \({\rm field} + {\rm real}\)
procedure :: field_sub_field => array_vector_vf_s_vf
!! \({\rm field} - {\rm field}\)
procedure, pass(rhs) :: real_sub_field => array_vector_r_s_vf
!! \({\rm real} - {\rm field}\)
procedure :: field_sub_real => array_vector_vf_s_r
!! \({\rm field} - {\rm real}\)
procedure, public :: norm => array_vector_norm
!! \(\lVert {\rm \vec{field}} \rVert\)
procedure, public :: component => array_vector_component
!! Returns a scalar field containing the specified component of
!! the vector field
procedure, public :: d_dx => array_vector_d_dx
!! \(\frac{\partial^n}{\partial x_i^n}({\rm \vec{field}})\)
procedure, public :: component_d_dx => array_vector_component_d_dx
!! \(\frac{\partial^n}{\partial x_i^n}({\rm field_j})\)
procedure :: divergence => array_vector_divergence
!! \(\nabla\cdot {\rm field}\)
procedure :: curl => array_vector_curl
!! \(\nabla\times {\rm field}\)
procedure :: laplacian => array_vector_laplacian
!! \(\nabla^2 {\rm field}\)
procedure :: field_dot_field => array_vector_vf_dot_vf
!! \({\rm \vec{field}} \cdot {\rm \vec{field}}\)
procedure :: field_dot_real => array_vector_vf_dot_vr
!! \({\rm \vec{field}} \cdot {\rm \vec{real}}\)
procedure, pass(rhs) :: real_dot_field => array_vector_vr_dot_vf
!! \({\rm \vec{real}} \cdot {\rm \vec{field}}\)
procedure :: field_cross_field => array_vector_vf_cross_vf
!! \({\rm\vec{field}} \times {\rm\vec{field}}\)
procedure :: field_cross_real => array_vector_vf_cross_vr
!! \({\rm\vec{field}} \times {\rm\vec{real}}\)
procedure, pass(rhs) :: real_cross_field => array_vector_vr_cross_vf
!! \({\rm\vec{real}} \times {\rm\vec{field}}\)
procedure :: assign_field => array_vector_assign
!! \({\rm field} = {\rm field}\)
procedure :: assign_scalar_fields => array_vector_assign_scalar
!! \({\rm \vec{field}} = [{\rm field1, field2, \ldots}]\)
procedure :: is_equal => array_vector_is_equal
!! Checks fields are equal within a tolerance
procedure, public :: assign_meta_data => array_vector_assign_meta_data
!! Copies all data other than values stored in field from another
!! field object to this one.
procedure, non_overridable, public :: read_hdf_array => array_vector_read_hdf
!! Reads the array of field data from an HDF file
procedure, non_overridable, public :: write_hdf_array => array_vector_write_hdf
!! Writes the array of field data to an HDF file
procedure(vf_meta), deferred :: assign_subtype_meta_data
!! Copies all data stored in a subtype of [[array_vector_field(type)]]
!! from another field object to this one.
procedure, non_overridable :: check_compatible => array_vector_compatible
!! Tests whether two fields are suitable for binary operations together
procedure(vf_compatible), deferred :: check_subtype_compatible
!! Tests whether two fields are suitable for binary operations
!! together, checking that any properties of subtypes of
!! [[array_vector_field(type)]] are compatible.
procedure(vf_scalar_dx), deferred :: array_dx
!! Takes the derivative of particular vector component of the
!! field, using a 1-D array of data passed to it.
procedure(vf_array_interp), deferred :: array_interpolate
!! Interpolates a value in the field, using a 2-D array of data
!! passed to it.
procedure :: get_element_vector => array_vector_get_element_vec
!! Returns ones of the constituent vectors of the field, i.e. the
!! field's value at a particular location.
procedure :: get_element_component => array_vector_get_element_comp
!! Returns one of the components of a constituent vector of the
!! field, i.e. the component of the field's value at a particular
!! location.
procedure :: set_element_vector => array_vector_set_element_vec
!! Sets ones of the constituent vectors of the field, i.e. the
!! field's value at a particular location.
procedure :: set_element_component => array_vector_set_element_comp
!! Sets one of the components of a constituent vector of the
!! field, i.e. the component of the field's value at a particular
!! location.
procedure, public :: set_deriv_element => array_vector_set_deriv_element
!! Sets ones of the constituent vectors of the field's
!! derivative, i.e. the field's deritive at a particular
!! location.
procedure, public :: get_boundary => array_vector_get_bound
!! Returns a field of the same type, containing only the
!! specified ammount of data at the specified boundary.
procedure, public :: set_derivative => array_vector_set_deriv
!! Sets a derivative value for this field, which gets propagated
!! through operations using automatic differentiation (tangent
!! mode).
procedure, public :: unset_derivative => array_vector_unset_deriv
!! Removes any derivative value for this field, turning off
!! automatic differentiation.
procedure, public :: get_derivative => array_vector_get_deriv
!! Provides the derivative value for this field. This was either
!! set by the user or calculated using automatic
!! differentiation. If no derivative information is available
!! for this object then a field of zeros is returned.
procedure, public :: has_derivative => array_vector_has_deriv
!! Indicates whether the field has a derivative value.
procedure, non_overridable :: allocate_deriv => array_vector_alloc_deriv
!! Decides whether to allocate the array containing the
!! derivative.
procedure(vf_bound), deferred :: subtype_boundary
!! Performs whatever operations are needed by the subtype to get
!! a boundary field, including returning the slices needed to
!! extract the appropriate data.
procedure, non_overridable :: is_allocated => array_vector_is_allocated
!! Indicates whether both the array pointer _and_ the array it
!! contains are allocated.
procedure, public :: finalise => array_vector_finalise
!! Deallocates the contents of the field. The bulk of the
!! field's memory should be deallocated with the `clean_temp`
!! method, but that is unable to deallocate the pointer to the
!! data array--only the array itself. In compilers which support
!! finalisation, this method eliminates the small memory leak
!! from the pointer.
procedure, public :: interpolate => array_vector_interp
!! Interpolates the value of the field at the specified
!! location.
end type array_vector_field
interface array_vector_field
module procedure array_vector_constructor1
module procedure array_vector_constructor2
end interface array_vector_field
abstract interface
function vf_raw_slices(this,exclude_lower_bound,exclude_upper_bound) &
result(slices)
import array_vector_field
class(array_vector_field), intent(in) :: this
integer, dimension(:), optional, intent(in) :: exclude_lower_bound
!! Specifies how many layers of data points should be excluded
!! from the result at the lower boundary for each
!! dimension. The number in element `n` of the array indicates
!! how many layers of cells at the lower boundary normal to
!! dimension `n` will be ignored. Defaults to 0 for all.
integer, dimension(:), optional, intent(in) :: exclude_upper_bound
!! Specifies how many layers of data points should be excluded
!! from the result at the upper boundary for each
!! dimension. The number in element `n` of the array indicates
!! how many layers of cells at the upper boundary normal to
!! dimension `n` will be ignored. Defaults to 0 for all.
integer, dimension(:,:), allocatable :: slices
!! An array containing array slice data which can be used to
!! construct the raw representation of a field, with the given
!! boundary conditions. The form of the array is
!! ```
!! slices(1,i) = start_index
!! slices(2,i) = end_index
!! slices(3,i) = stride
!! ```
end function vf_raw_slices
subroutine vf_bound(this,src,boundary,depth,slices)
import :: array_vector_field
class(array_vector_field), intent(inout) :: this
class(array_vector_field), intent(in) :: src
!! The field for which the boundary data is to be provided.
integer, intent(in) :: boundary
!! Specifies which boundary is to be returned. The boundary
!! will be the one normal to dimension of number
!! `abs(boundary)`. If the argument is negative, then the
!! lower boundary is returned. If positive, then the upper
!! boundary is returned.
integer, intent(in) :: depth
!! The number of layers of data-points to return at the
!! specified boundary.
integer, dimension(:,:), allocatable, intent(out) :: slices
!! An array containing array slice data which can be used to
!! construct extract the data for the given field
!! boundary. The form of the array is
!! ```
!! slices(1,i) = start_index
!! slices(2,i) = end_index
!! slices(3,i) = stride
!! ```
end subroutine vf_bound
subroutine vf_compatible(this,other)
!* Author: Chris MacMackin
! Date: September 2016
!
! Checks whether a field has the same type, boundaries, and
! resolution as this one, making it compatible for binary
! operations. If incompatible, stops program with an error message.
!
import :: array_vector_field
import :: abstract_field
class(array_vector_field), intent(in) :: this
class(abstract_field), intent(in) :: other
!! The field being checked against this one
end subroutine vf_compatible
subroutine vf_meta(this, rhs)
import :: array_vector_field
import :: abstract_field
class(array_vector_field), intent(inout) :: this
class(abstract_field), intent(in) :: rhs
!! The field whose metadata (data which are not field vales)
!! is to be copied
end subroutine vf_meta
function vf_scalar_dx(this, data_array, dir, order) result(res)
import :: array_vector_field
import :: r8
class(array_vector_field), intent(in) :: this
real(r8), dimension(:), intent(in) :: data_array
!! An array holding the datapoints for a component of the
!! vectors in this field, with identical in layout to the
!! storage in the field itself.
integer, intent(in) :: dir
!! Direction in which to differentiate
integer, intent(in), optional :: order
!! Order of the derivative, default = 1
real(r8), dimension(:), allocatable :: res
!! The spatial derivative of order `order` taken in direction `dir`
end function vf_scalar_dx
function vf_array_interp(this, data_array, location) result(val)
import :: array_vector_field
import :: r8
class(array_vector_field), intent(in) :: this
real(r8), dimension(:,:), intent(in) :: data_array
!! An array holding the datapoints for this field, identical
!! in layout to that stored the field itself.
real(r8), dimension(:), intent(in) :: location
!! The location at which to calculate the interpolated value.
real(r8), dimension(:), allocatable :: val
!! The spatial derivative of order `order` taken in direction `dir`
end function vf_array_interp
function vector_init(x) result(vector)
!! Function used to specify value held by a vector field at
!! location `x`.
import :: r8
real(r8), dimension(:), intent(in) :: x
!! The position at which this function is evaluated
real(r8), dimension(:), allocatable :: vector
!! The value of the field at this location
end function vector_init
end interface
public :: scalar_init, vector_init
interface allocate_like
!! Helper routines to allocate one array to have a
!! similar shape to another.
module procedure :: allocate_like_1d_1d
module procedure :: allocate_like_1d_2d
module procedure :: allocate_like_2d_1d
module procedure :: allocate_like_2d_2d
module procedure :: allocate_like_2d_2d_1d
end interface
contains
subroutine allocate_like_1d_1d(array, mold, alloc)
!* Author: Chris MacMackin
! Date: March 2018
!
! Allocates an array to have the same shape as an existing one.
!
real(r8), allocatable, dimension(:), intent(inout) :: array
!! The array to be allocated
real(r8), allocatable, dimension(:), intent(in) :: mold
!! The array whose shape is used to allocate the first argument
logical, optional, intent(in) :: alloc
!! If present and false, do not allocate the array
logical :: al
integer :: n
if (present(alloc)) then
al = alloc
else
al = .true.
end if
if (al .and. allocated(mold)) then
n = size(mold)
if (allocated(array)) then
if (size(array) /= n) then
deallocate(array)
allocate(array(n))
end if
else
allocate(array(n))
end if
else if (allocated(array)) then
deallocate(array)
end if
end subroutine allocate_like_1d_1d
subroutine allocate_like_1d_2d(array, mold, alloc)
!* Author: Chris MacMackin
! Date: March 2018
!
! Allocates an array to have the same shape as an existing one.
!
real(r8), allocatable, dimension(:), intent(inout) :: array
!! The array to be allocated
real(r8), allocatable, dimension(:,:), intent(in) :: mold
!! The array whose shape is used to allocate the first argument
logical, optional, intent(in) :: alloc
!! If present and false, do not allocate the array
logical :: al
integer :: n
if (present(alloc)) then
al = alloc
else
al = .true.
end if
if (al .and. allocated(mold)) then
n = size(mold, 1)
if (allocated(array)) then
if (size(array) /= n) then
deallocate(array)
allocate(array(n))
end if
else
allocate(array(n))
end if
else if (allocated(array)) then
deallocate(array)
end if
end subroutine allocate_like_1d_2d
subroutine allocate_like_2d_1d(array, mold, n2, alloc)
!* Author: Chris MacMackin
! Date: March 2018
!
! Allocates an array to have the same shape as an existing one.
!
real(r8), allocatable, dimension(:,:), intent(inout) :: array
!! The array to be allocated
real(r8), allocatable, dimension(:), intent(in) :: mold
!! The array whose shape is used to allocate the first argument
integer, optional, intent(in) :: n2
!! Desired size of array in the second dimension. Deafualt is 1.
logical, optional, intent(in) :: alloc
!! If present and false, do not allocate the array
logical :: al
integer :: n0, n1
if (present(alloc)) then
al = alloc
else
al = .true.
end if
if (al .and. allocated(mold)) then
n0 = size(mold, 1)
if (present(n2)) then
n1 = n2
else
n1 = 1
end if
if (allocated(array)) then
if (size(array, 1) /= n0 .or. size(array, 2) /= n1) then
deallocate(array)
allocate(array(n0, n1))
end if
else
allocate(array(n0, n1))
end if
else if (allocated(array)) then
deallocate(array)
end if
end subroutine allocate_like_2d_1d
subroutine allocate_like_2d_2d(array, mold, mold2, alloc)
!* Author: Chris MacMackin
! Date: March 2018
!
! Allocates an array to have the same shape as an existing one.
!
real(r8), allocatable, dimension(:,:), intent(inout) :: array
!! The array to be allocated
real(r8), allocatable, dimension(:,:), intent(in) :: mold
!! The array whose shape is used to allocate the first argument
real(r8), optional, allocatable, dimension(:,:), intent(in) :: mold2
!! A second array which, if present, will be compared with that
!! of `mold` to decide the size to allocate the second
!! dimenions. This will be the larger of the second dimensions
!! in `mold1` and `mold2`
logical, optional, intent(in) :: alloc
!! If present and false, do not allocate the array
logical :: al
integer :: n0, n1
if (present(alloc)) then
al = alloc
else
al = .true.
end if
if (al .and. allocated(mold)) then
n0 = size(mold, 1)
n1 = size(mold, 2)
if (present(mold2)) n1 = max(n1, size(mold2, 2))
if (allocated(array)) then
if (size(array, 1) /= n0 .or. size(array, 2) /= n1) then
deallocate(array)
allocate(array(n0, n1))
end if
else
allocate(array(n0, n1))
end if
else if (allocated(array)) then
deallocate(array)
end if
end subroutine allocate_like_2d_2d
subroutine allocate_like_2d_2d_1d(array, mold, mold2, alloc)
!* Author: Chris MacMackin
! Date: March 2018
!
! Allocates an array to have the same shape as an existing one.
!
real(r8), allocatable, dimension(:,:), intent(inout) :: array
!! The array to be allocated
real(r8), allocatable, dimension(:,:), intent(in) :: mold
!! The array whose shape is used to allocate the first argument
real(r8), dimension(:), intent(in) :: mold2
!! A second array which will be compared with that
!! of `mold` to decide the size to allocate the second
!! dimenions. This will be the larger of the second dimension
!! of `mold1` and the first of `mold2`
logical, optional, intent(in) :: alloc
!! If present and false, do not allocate the array
logical :: al
integer :: n0, n1
if (present(alloc)) then
al = alloc
else
al = .true.
end if
if (al .and. allocated(mold)) then
n0 = size(mold, 1)
n1 = max(size(mold, 2), size(mold2))
if (allocated(array)) then
if (size(array, 1) /= n0 .or. size(array, 2) /= n1) then
deallocate(array)
allocate(array(n0, n1))
end if
else
allocate(array(n0, n1))
end if
else if (allocated(array)) then
deallocate(array)
end if
end subroutine allocate_like_2d_2d_1d
!=====================================================================
! Scalar Field Methods
!=====================================================================
function array_scalar_constructor1(template,numpoints, &
initializer) result(this)
!* Author: Chris MacMackin
! Date: October 2016
!
! Creates a new field with the same concrete type as the template
! argument. The array of values will be allocated and initiated.
!
class(array_scalar_field), intent(in) :: template
!! A scalar field object which will act as a mold for the concrete
!! type of the returned type, also copying over any metadata.
integer, intent(in) :: numpoints
!! The number of data points needed in the array when modelling this
!! field.
procedure(scalar_init), optional :: initializer
!! An impure elemental procedure taking which takes the position in the
!! fields domain (an 8-byte real) as an argument and returns the
!! fields value at that position. Default is for field to be zero
!! everywhere.
class(scalar_field), pointer :: this
!! A scalar field initiated based on the arguments to this function.
integer :: i
call template%guard_temp()
call template%allocate_scalar_field(this)
call this%unset_temp()
select type(this)
class is(array_scalar_field)
this%has_deriv = .false.
call this%assign_subtype_meta_data(template)
if (allocated(this%field_data)) then
if (size(this%field_data) /= numpoints) then
deallocate(this%field_data)
allocate(this%field_data(numpoints))
end if
else
allocate(this%field_data(numpoints))
end if
this%numpoints = numpoints
if (present(initializer)) then
do i = 1, numpoints
this%field_data(i) = initializer(this%id_to_position(i))
end do
else
this%field_data = 0
end if
class default
error stop ('Non-array_scalar_field type allocated by '//&
'`allocate_scalar_field` routine.')
end select
call template%clean_temp()
call this%set_temp()
end function array_scalar_constructor1
function array_scalar_constructor2(template, array) result(this)
!* Author: Chris MacMackin
! Date: December 2016
!
! Creates a new field with the same concrete type as the template
! argument. The field values will be copied from the provided array.
!
class(array_scalar_field), intent(in) :: template
!! A scalar field object which will act as a mold for the concrete
!! type of the returned type, also copying over any metadata.
real(r8), dimension(:), intent(in) :: array
!! An array containing the values which this field will be
!! initialised with.
class(scalar_field), pointer :: this
!! A scalar field initiated based on the arguments to this function.
call template%guard_temp()
call template%allocate_scalar_field(this)
select type(this)
class is(array_scalar_field)
this%has_deriv = .false.
call this%assign_subtype_meta_data(template)
if (.not. allocated(this%field_data)) then
allocate(this%field_data(size(array)))
else
if (size(this%field_data) /= size(array)) then
deallocate(this%field_data)
allocate(this%field_data(size(array)))
end if
end if
this%numpoints = size(array)
this%field_data = array
class default
error stop ('Non-array_scalar_field type allocated by '//&
'`allocate_scalar_field` routine.')
end select
call template%clean_temp()
end function array_scalar_constructor2
function array_scalar_elements(this) result(elements)
!* Author: Chris MacMackin
! Date: October 2016
!
! Gives the number of individual data points present in the field.
!
class(array_scalar_field), intent(in) :: this
integer :: elements
call this%guard_temp()
elements = this%numpoints
call this%clean_temp()
end function array_scalar_elements
function array_scalar_raw_size(this,exclude_lower_bound, &
exclude_upper_bound) result(res)
!* Author: Chris MacMackin
! Date: March 2016
!
! Compute how many elements are in the raw representation of this
! field. This would be the number of data points, adjusted based on
! how boundary conditions are accounted for.
!
class(array_scalar_field), intent(in) :: this
integer, dimension(:), optional, intent(in) :: exclude_lower_bound
!! Specifies how many layers of data points should be excluded
!! from the result at the lower boundary for each
!! dimension. The number in element `n` of the array indicates
!! how many layers of cells at the lower boundary normal to
!! dimension `n` will be ignored. Defaults to 0 for all.
integer, dimension(:), optional, intent(in) :: exclude_upper_bound
!! Specifies how many layers of data points should be excluded
!! from the result at the upper boundary for each
!! dimension. The number in element `n` of the array indicates
!! how many layers of cells at the upper boundary normal to
!! dimension `n` will be ignored. Defaults to 0 for all.
integer :: res
integer, dimension(:,:), allocatable :: slices
integer :: i
call this%guard_temp()
if (this%is_allocated()) then
slices = this%raw_slices(exclude_lower_bound,exclude_upper_bound)
res = sum(elements_in_slice(slices(1,:),slices(2,:),slices(3,:)))
else
res = 0
end if
call this%clean_temp()
end function array_scalar_raw_size
function array_scalar_raw(this,exclude_lower_bound, &
exclude_upper_bound) result(res)
!* Author: Chris MacMackin