Field3DParallel #3149

dschwoerer · 2025-07-16T12:09:30Z

This should replace #3004

Field3DParallel enforces that parallel derivatives can be taken. This means for FCI, parallel fields are present. It also ensures that if an operation is taken on such a field, the parallel fields are retained. This replaces part of fci-automagic, that always retained parallel fields on operations.

dicts have been preserving order for several releases now.

github-actions

clang-tidy made some suggestions

github-actions · 2025-07-16T12:16:23Z

include/bout/deriv_store.hxx

@@ -533,4 +533,13 @@ private:
  }
 };

+template <typename T>
+auto& getStore() {
+  if constexpr (std::is_same<T, Field3DParallel>::value) {


warning: no header providing "Field3DParallel" is directly included [misc-include-cleaner]

include/bout/deriv_store.hxx:36:

- #include <bout/scorepwrapper.hxx> + #include "bout/field3d.hxx" + #include <bout/scorepwrapper.hxx>

github-actions · 2025-07-16T12:16:23Z

include/bout/deriv_store.hxx

@@ -533,4 +533,13 @@ private:
  }
 };

+template <typename T>
+auto& getStore() {
+  if constexpr (std::is_same<T, Field3DParallel>::value) {


warning: no header providing "std::is_same" is directly included [misc-include-cleaner]

include/bout/deriv_store.hxx:34:

- #include <unordered_map> + #include <type_traits> + #include <unordered_map>

github-actions · 2025-07-16T12:16:23Z

include/bout/deriv_store.hxx

+template <typename T>
+auto& getStore() {
+  if constexpr (std::is_same<T, Field3DParallel>::value) {
+    return DerivativeStore<Field3D>::getInstance();


warning: no header providing "Field3D" is directly included [misc-include-cleaner]

return DerivativeStore<Field3D>::getInstance(); ^

include/bout/field3d.hxx

github-actions · 2025-07-16T12:16:24Z

include/bout/index_derivs_interface.hxx

@@ -369,6 +364,11 @@ T VDDY(const T& vel, const T& f, CELL_LOC outloc = CELL_DEFAULT,
    return are_unaligned ? fromFieldAligned(result, region) : result;
  }
 }
+inline Field3D VDDY(const Field3D& v, const Field3DParallel& f,


warning: no header providing "Field3DParallel" is directly included [misc-include-cleaner]

include/bout/index_derivs_interface.hxx:31:

- #include "bout/traits.hxx" + #include "bout/field3d.hxx" + #include "bout/traits.hxx"

src/field/field3d.cxx

github-actions · 2025-07-16T12:16:24Z

src/field/generated_fieldops.cxx

+  result.setRegion(lhs.getMesh()->getCommonRegion(lhs.getRegionID(), rhs.getRegionID()));
+  if (lhs.isFci()) {
+    result.splitParallelSlices();
+    for (size_t i{0}; i < lhs.numberParallelSlices(); ++i) {


warning: no header providing "size_t" is directly included [misc-include-cleaner]

src/field/generated_fieldops.cxx:7:

+ #include <cstddef>

github-actions · 2025-07-16T12:16:24Z

src/mesh/coordinates.cxx

@@ -1510,8 +1510,8 @@ Coordinates::FieldMetric Coordinates::DDY(const Field2D& f, CELL_LOC loc,
  return bout::derivatives::index::DDY(f, loc, method, region) / dy;
 }

-Field3D Coordinates::DDY(const Field3D& f, CELL_LOC outloc, const std::string& method,
-                         const std::string& region) const {
+Field3D Coordinates::DDY(const Field3DParallel& f, CELL_LOC outloc,


warning: no header providing "Field3DParallel" is directly included [misc-include-cleaner]

Field3D Coordinates::DDY(const Field3DParallel& f, CELL_LOC outloc, ^

github-actions · 2025-07-16T12:16:24Z

src/sys/derivs.cxx

@@ -70,7 +70,7 @@ Coordinates::FieldMetric DDX(const Field2D& f, CELL_LOC outloc, const std::strin

 ////////////// Y DERIVATIVE /////////////////

-Field3D DDY(const Field3D& f, CELL_LOC outloc, const std::string& method,
+Field3D DDY(const Field3DParallel& f, CELL_LOC outloc, const std::string& method,


warning: no header providing "Field3DParallel" is directly included [misc-include-cleaner]

Field3D DDY(const Field3DParallel& f, CELL_LOC outloc, const std::string& method, ^

ZedThree · 2025-07-16T14:46:33Z

Nice, thanks @dschwoerer! Please could you add a docstring to the class to explain the motivation for it, when it should be used and how?

I think most of the clang-tidy warnings can be fixed automatically if you run it locally

Otherwise, the Field3DParallel is casted to Field3D and the wrong overloads are used

The communication was a no-op, as that did never calculate the parallel fields.

It is needed for e.g. calculating d1_dy

They should return Field3D, not Field3DParallel

include/bout/field3d.hxx

It seems something changed, that make hypre be less precise

Bumps [ZedThree/clang-tidy-review](https://github.com/zedthree/clang-tidy-review) from 0.20.1 to 0.21.0. - [Release notes](https://github.com/zedthree/clang-tidy-review/releases) - [Changelog](https://github.com/ZedThree/clang-tidy-review/blob/master/CHANGELOG.md) - [Commits](ZedThree/clang-tidy-review@v0.20.1...v0.21.0) --- updated-dependencies: - dependency-name: ZedThree/clang-tidy-review dependency-version: 0.21.0 dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <[email protected]>

Bump ZedThree/clang-tidy-review from 0.20.1 to 0.21.0

github-actions

clang-tidy made some suggestions

include/bout/field3d.hxx

github-actions · 2025-07-18T09:10:08Z

include/bout/index_derivs_interface.hxx

@@ -177,6 +177,11 @@ T DDX(const T& f, CELL_LOC outloc = CELL_DEFAULT, const std::string& method = "D
  AUTO_TRACE();
  return standardDerivative<T, DIRECTION::X, DERIV::Standard>(f, outloc, method, region);
 }
+inline Field3D DDX(const Field3DParallel& f, CELL_LOC outloc = CELL_DEFAULT,


warning: no header providing "Field3DParallel" is directly included [misc-include-cleaner]

include/bout/index_derivs_interface.hxx:31:

- #include "bout/traits.hxx" + #include "bout/field3d.hxx" + #include "bout/traits.hxx"

dschwoerer · 2025-07-18T10:45:51Z

I think most of the clang-tidy warnings can be fixed automatically if you run it locally

I tried

git diff -U0 origin/fci-auto-with-debug-higher-order | \
     clang-tidy-diff.py -p1 -path build-cont-debug/ -fix -config-file .clang-tidy -j 8

but that only added one header. Do you know how to run clang-tidy on this diff?

dschwoerer · 2025-07-21T08:46:30Z

The hypre3d test is failing with 2d metrics, as it seems it is not setting the y-boundaries in the SOL, but only in the core region.

This is needed for 2D metrics, and in this case we probably want to clear the parallel fields.

the functions where implemented, but not defined in the header

github-actions

clang-tidy made some suggestions

github-actions · 2025-07-21T09:42:05Z

include/bout/field.hxx

-      BOUT_FOR(d, result.yup(i).getRegion(rgn)) {
-        if (result.yup(i)[d] < f) {
-          result.yup(i)[d] = f;
+  if constexpr (std::is_same_v<T, Field3DParallel>) {


warning: use of undeclared identifier 'Field3DParallel' [clang-diagnostic-error]

} ^

dschwoerer and others added 7 commits June 26, 2025 10:53

No need for orderedDicts

d1c5689

dicts have been preserving order for several releases now.

Remove wrong comment, FieldPerp is present

e01bda2

Implement more of Field3DParallel

86dc232

Start using Field3DParallel for derivatives

167e39e

Do not use separate derivative store for Field3DParallel

59445b6

Apply clang-format changes

1f3521f

github-actions bot reviewed Jul 16, 2025

View reviewed changes

Do not change non-FCI fields

8c40bad

dschwoerer added 2 commits July 17, 2025 10:05

Merge remote-tracking branch 'origin/next' into f3dwy

3f859b3

Merge branch 'fci-auto-with-debug-higher-order' into f3dwy

05dd58e

dschwoerer force-pushed the f3dwy branch from aa76524 to 05dd58e Compare July 17, 2025 08:22

dschwoerer and others added 9 commits July 17, 2025 11:02

Add function to header file

784d381

Otherwise, the Field3DParallel is casted to Field3D and the wrong overloads are used

Ensure emptyFrom works

b880846

Use f3dwy to preserve parallel fields

844f2d4

The communication was a no-op, as that did never calculate the parallel fields.

Also load dy

25fd12f

It is needed for e.g. calculating d1_dy

Preserve parallel fields for d1_dy calculation

5e1a3df

Add overloads for DD?(Field3DParallel)

e034ddd

They should return Field3D, not Field3DParallel

Apply clang-format changes

cdcb380

add asF3dwy() stub to Field2D

da7865d

Apply clang-format changes

6a75dfc

ZedThree reviewed Jul 18, 2025

View reviewed changes

include/bout/field3d.hxx Outdated Show resolved Hide resolved

dschwoerer and others added 6 commits July 18, 2025 10:20

Loosen tolerance for hypre3d test

79af980

It seems something changed, that make hypre be less precise

Merge pull request #3150 from boutproject/bump-clang-tidy-review

f133bdb

Bump ZedThree/clang-tidy-review from 0.20.1 to 0.21.0

Merge remote-tracking branch 'origin/next' into f3dwy

cb29794

Add some documentation

3e9bdfd

Be more explicit in the naming

24e96d0

github-actions bot reviewed Jul 18, 2025

View reviewed changes

Apply clang-tidy fix

196138a

dschwoerer and others added 10 commits July 21, 2025 10:54

Disable hypre3d test

a7acfc3

do not use const for BoutReal in signature

b8da0fb

Add Field3DParallel + Field2D fieldops

f32693d

This is needed for 2D metrics, and in this case we probably want to clear the parallel fields.

Move function definition after class definition

0ecf55c

Prefer std::move

3012a22

Apply clang-format changes

63a78d9

Add binary operators Field2D - FieldPerp

2f98162

the functions where implemented, but not defined in the header

Remove some FCI_AUTOMAGIC

fdbbed6

Only use "parallel_neumann_o2" if no other parallel bc set

cb643eb

Apply clang-format changes

86fc85b

github-actions bot reviewed Jul 21, 2025

View reviewed changes

Declare Field3DParallel

857e8c3

Field3DParallel #3149

Are you sure you want to change the base?

Field3DParallel #3149

Conversation

dschwoerer commented Jul 16, 2025

Uh oh!

github-actions bot left a comment

Choose a reason for hiding this comment

Uh oh!

github-actions bot Jul 16, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot Jul 16, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot Jul 16, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

github-actions bot Jul 16, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

github-actions bot Jul 16, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot Jul 16, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot Jul 16, 2025

Choose a reason for hiding this comment

Uh oh!

ZedThree commented Jul 16, 2025

Uh oh!

Uh oh!

github-actions bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

github-actions bot Jul 18, 2025

Choose a reason for hiding this comment

Uh oh!

dschwoerer commented Jul 18, 2025

Uh oh!

dschwoerer commented Jul 21, 2025

Uh oh!

github-actions bot left a comment

Choose a reason for hiding this comment

Uh oh!

github-actions bot Jul 21, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!