1D tally maps #122

valeriaRaffuzzi · 2024-04-15T18:36:23Z

Just tidying the maps a bit: if we want to keep the separation between tallyMaps and tallyMaps1D, which is useful for the multiMaps, I think some order makes things clearer.

The main changes are:

moving all the 1D maps and tests into a new folder: TallyMaps/Maps1D
renaming sphericalMap -> sphericalRadMap, given that only the radial dimension was mapped. If one wants to make a multidimensional sphericalMap, then that would be a TallyMap
Making a version of cylindricalMap with only the radial components: /Maps1D/cylindricalRadMap
Adding a directionMap to map the direction of flight of the particles. For now only a linear grid (0-2pi) is allowed, and the user needs to choose the 2D plane of interest.

I forgot to update the User manual, I'll do it after the reviews to make sure I am not missing anything given that a lot has to be changed.

…nto angleMap

valeriaRaffuzzi · 2024-04-15T19:36:58Z

Tallies/TallyMaps/Maps1D/directionMap_class.f90

+    do i = 1, self % N
+      ! Print lower bin boundary
+      call out % addValue(self % bounds % bin(i) + PI)
+
+      ! Print upper bin boundar
+      call out % addValue(self % bounds % bin(i + 1) + PI)
+    end do


Suggested change

do i = 1, self % N

! Print lower bin boundary

call out % addValue(self % bounds % bin(i) + PI)

! Print upper bin boundar

call out % addValue(self % bounds % bin(i + 1) + PI)

end do

do i = 1, self % N

! Print lower bin boundary

call out % addValue(self % bounds % bin(i))

! Print upper bin boundar

call out % addValue(self % bounds % bin(i + 1))

end do

NOTE: otherwise the bins don't coincide with the bins of the results.

valeriaRaffuzzi · 2024-04-15T19:39:11Z

Tallies/TallyMaps/cylindricalMap_class.f90

Lines 379 - 382: also remove PI from the printed bin values

ChasingNeutrons · 2024-04-16T09:53:03Z

One question before I dive in: would it be neater to have a generic radial map where you can specify which dimensions/plane/axis to account for? For example, it could be xy, xz, yz, or xyz (spherical). This is as opposed to having separate cylindrical and spherical radial maps.

valeriaRaffuzzi · 2024-04-16T10:35:18Z

One question before I dive in: would it be neater to have a generic radial map where you can specify which dimensions/plane/axis to account for? For example, it could be xy, xz, yz, or xyz (spherical). This is as opposed to having separate cylindrical and spherical radial maps.

Yes that should be easy enough! Let me give it a quick try.

ChasingNeutrons · 2024-04-17T12:48:18Z

Tallies/TallyMaps/Maps1D/Tests/directionMap_test.f90

@@ -0,0 +1,153 @@
+module directionMap_test


Perhaps more descriptively it should be azimuthalDirectionMap or something similar? This would be to distinguish it from an eventual polar direction map.

ChasingNeutrons · 2024-04-17T12:52:19Z

Tallies/TallyMaps/Maps1D/directionMap_class.f90

@@ -0,0 +1,194 @@
+module directionMap_class


Meant to put that previous comment here...

No worries, I understood! It's a bit of a long name. I personally would leave it as it is until a polarMap comes by. Also because you can map direction on any plane with this, so it's quite general.

Going from -pi to pi it is still the azimuthal component of direction, which is not inherent to any plane. I would suggest it's better to rename it in advance of having polar because it is more descriptive and helps us not forget. Even something like azimuthDirMap.

In this case, it might be even more convenient to leave it generic and add the possibility to modify the angle range to anything within -PI to PI. So one could tally -PI to PI on a plane and 0 to PI on another

I suppose it would still be a fraction of the azimuthal plane. Wouldn't the polar equivalent need some weighting by a sine? But, in principle, the range could be limited. I imagine that might make things a bit messier and also wouldn't be requested very frequently so I wouldn't worry much about it.

One more thing: which direction would the 0 angle correspond to in a given plane? Or pi/2? It would be good to mention these explicitly at least in the comments.

I think that if you want to integrate over a polar angle you need to add the sign weighting as a Response, rather than in the tally Map. Now I added a custom min and max angle, so that it generalises better.

Tallies/TallyMaps/Maps1D/directionMap_class.f90

ChasingNeutrons · 2024-04-17T12:55:04Z

Tallies/TallyMaps/Maps1D/directionMap_class.f90

+        self % DIM2 = Y_AXIS
+
+      case default
+        call fatalError(Here, 'Keyword orientation must be x, y or z. It is: '//type)


This or the cases would need to change.

Tallies/TallyMaps/Maps1D/directionMap_class.f90

ChasingNeutrons · 2024-04-17T12:59:33Z

Tallies/TallyMaps/Maps1D/radialMap_class.f90

+        spherical = .true.
+
+      case default
+        call fatalError(Here, 'Keyword orientation must be x, y, z or nothing for spherical. It is: '//type)


This error is inconsistent with the spherical case above.

I would add it might be good idea to include xyz keyword in the doc comment. As suggested above

Tallies/TallyMaps/Tests/cylindricalMap_test.f90

Mikolaj-A-Kowalski

Looks good to me with just couple of minor issues.
Thanks for the addition!

Mikolaj-A-Kowalski · 2024-04-26T12:39:51Z

Tallies/TallyMaps/Maps1D/directionMap_class.f90

+  !!
+  !! Maps the particle direction in linear bins in the range 0-360 degrees
+  !!


I believe this description is not up to date. The maps works in -pi pi range in radians, right?
We should also mention with respect to what the angle is measured and highlight that user can specify the plane?

Yeah it was. Now I changed it to be defined in degrees from -180 to 180, given that degrees are more intuitive I think. I added those comments.

Mikolaj-A-Kowalski · 2024-04-26T12:46:56Z

Tallies/TallyMaps/Maps1D/radialMap_class.f90

+        spherical = .true.
+
+      case default
+        call fatalError(Here, 'Keyword orientation must be x, y, z or nothing for spherical. It is: '//type)


I would add it might be good idea to include xyz keyword in the doc comment. As suggested above

Mikolaj-A-Kowalski · 2024-04-26T12:47:39Z

Tallies/TallyMaps/Maps1D/radialMap_class.f90

+  !! Sample Dictionary Input:
+  !!  radialMap {
+  !!    type radialMap;
+  !!    axis x;                 // Optional. Default is spherical map


Suggested change

!! axis x; // Optional. Default is spherical map

!! axis x; // Optional. Default is 'xyz' (spherical map)

Mikolaj-A-Kowalski · 2024-04-26T12:52:26Z

Tallies/TallyMaps/Maps1D/radialMap_class.f90

+    ! Check & load origin
+    if (spherical) then
+      call dict % getOrDefault(self % origin, 'origin', [ZERO, ZERO, ZERO])
+    else
+      call dict % getOrDefault(self % origin, 'origin', [ZERO, ZERO])
+    end if


We should check the size of the origin? I am not sure if it is done.
Also perhaps we should always use all 3 coordinates? Origin is a point in space, one coordinate will be redundant, sure, but I know I will be getting confused about what are the axis if we switch two two only for cylinders ;-) [Basically like it is done for cylindrical surfaces]

I guess I was imitating what done in cylinderMap, where the origin only had two entries. I am changing both cylinderMap and radialMap to read origins with 3 entries to avoid confusion for the user.

Mikolaj-A-Kowalski · 2024-04-26T12:57:11Z

Tallies/TallyMaps/Maps1D/radialMap_class.f90

+    ! Calculate the distance from the origin
+    r = norm2(state % r(self % axis) - self % origin)


Suggested change

! Calculate the distance from the origin

r = norm2(state % r(self % axis) - self % origin)

! Calculate the distance from the origin

r = norm2(state % r(self % axis) - self % origin(self % axis))

Assuming that we are using size 3 origin.

valeriaRaffuzzi · 2024-05-16T15:37:42Z

I'll ho ahead and merge this, given that it was approved and only a couple of aesthetic things changed since!

V. Raffuzzi(vr339) added 2 commits April 15, 2024 19:27

Tidying the 1D tally maps, adding 1D radial and angular maps

faec966

Merge branch 'angleMap' of https://github.com/valeriaRaffuzzi/SCONE i…

3d6a9c4

…nto angleMap

valeriaRaffuzzi commented Apr 15, 2024

View reviewed changes

Tallies/TallyMaps/cylindricalMap_class.f90 Outdated

Copy link

Member Author

valeriaRaffuzzi Apr 15, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Lines 379 - 382: also remove PI from the printed bin values

Merge cyl and sph radial maps into one radialMap

98ec4df

ChasingNeutrons reviewed Apr 17, 2024

View reviewed changes

Tallies/TallyMaps/Maps1D/directionMap_class.f90 Outdated Show resolved Hide resolved

ChasingNeutrons reviewed Apr 17, 2024

View reviewed changes

Tallies/TallyMaps/Maps1D/directionMap_class.f90 Outdated Show resolved Hide resolved

ChasingNeutrons reviewed Apr 17, 2024

View reviewed changes

Tallies/TallyMaps/Tests/cylindricalMap_test.f90 Outdated Show resolved Hide resolved

Mikolaj-A-Kowalski approved these changes May 1, 2024

View reviewed changes

V. Raffuzzi(vr339) added 2 commits May 5, 2024 17:21

Updating the directionMap to degrees, and updating the docs

6989dfb

Making the origin 3D in all cases

64a09b9

valeriaRaffuzzi merged commit a7b7218 into CambridgeNuclear:main May 16, 2024
5 checks passed

valeriaRaffuzzi deleted the angleMap branch May 16, 2024 15:37

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

1D tally maps #122

1D tally maps #122

valeriaRaffuzzi commented Apr 15, 2024

valeriaRaffuzzi Apr 15, 2024

valeriaRaffuzzi Apr 15, 2024

ChasingNeutrons commented Apr 16, 2024

valeriaRaffuzzi commented Apr 16, 2024

ChasingNeutrons Apr 17, 2024

ChasingNeutrons Apr 17, 2024

valeriaRaffuzzi Apr 17, 2024

ChasingNeutrons Apr 17, 2024

valeriaRaffuzzi Apr 17, 2024

ChasingNeutrons Apr 17, 2024

valeriaRaffuzzi May 5, 2024

ChasingNeutrons Apr 17, 2024

ChasingNeutrons Apr 17, 2024

Mikolaj-A-Kowalski Apr 26, 2024

Mikolaj-A-Kowalski left a comment

Mikolaj-A-Kowalski Apr 26, 2024

valeriaRaffuzzi May 5, 2024

Mikolaj-A-Kowalski Apr 26, 2024

Mikolaj-A-Kowalski Apr 26, 2024

Mikolaj-A-Kowalski Apr 26, 2024

valeriaRaffuzzi May 5, 2024 •

edited

Loading

Mikolaj-A-Kowalski Apr 26, 2024

valeriaRaffuzzi commented May 16, 2024

	!! axis x; // Optional. Default is spherical map
	!! axis x; // Optional. Default is 'xyz' (spherical map)

		! Calculate the distance from the origin
		r = norm2(state % r(self % axis) - self % origin)

1D tally maps #122

1D tally maps #122

Conversation

valeriaRaffuzzi commented Apr 15, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ChasingNeutrons commented Apr 16, 2024

valeriaRaffuzzi commented Apr 16, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Mikolaj-A-Kowalski left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

valeriaRaffuzzi May 5, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

valeriaRaffuzzi commented May 16, 2024

valeriaRaffuzzi May 5, 2024 •

edited

Loading