Legacy boundary conditions by malamast · Pull Request #3420 · boutproject/BOUT-dev

malamast · 2026-07-08T00:30:03Z

Added a legacy implementation of 1st order Dirichlet and Neumann BCs.

This is what we used to do in Bout++ version 3.
The default BC remain unchanged.
Higher order extrapolation can be unstable sometimes when using C4 so I added back the 1st order BC.
You can use them in the input file by setting e.g. bndry_all = dirichlet_o1.
Implementation for staggered grids is not done.

…et and Neumann BCs. - This is what we used to do in Bout++ version 3. - Higher order extrapolation can be unstable sometimes so I added back the 1st order BC. You can use thm in the input file by setting e.g. dirichlet_o1. - Implementation for staggered grids is not done.

… the rest of the BC code. -This was a later change to the BCs

github-actions

clang-tidy made some suggestions

There were too many comments to post at once. Showing the first 25 out of 54. Check the log or trigger a new build to see more.

github-actions · 2026-07-08T00:33:42Z

+class BoundaryDirichlet_O1 : public BoundaryOp {
+public:
+  BoundaryDirichlet_O1() : gen(nullptr) {}
+  BoundaryDirichlet_O1(BoundaryRegion* region, std::shared_ptr<FieldGenerator> g)


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

include/bout/boundary_standard.hxx:7:

- #include "bout/unused.hxx" + #include "bout/sys/expressionparser.hxx" + #include "bout/unused.hxx"

github-actions · 2026-07-08T00:33:42Z

+class BoundaryDirichlet_O1 : public BoundaryOp {
+public:
+  BoundaryDirichlet_O1() : gen(nullptr) {}
+  BoundaryDirichlet_O1(BoundaryRegion* region, std::shared_ptr<FieldGenerator> g)


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

include/bout/boundary_standard.hxx:10:

- #include <utility> + #include <memory> + #include <utility>

github-actions · 2026-07-08T00:33:42Z


 BoundaryFactory::BoundaryFactory() {
-  add(new BoundaryDirichlet(), "dirichlet");
+  add(new BoundaryDirichlet(), "dirichlet");       // Default


warning: initializing non-owner argument of type 'BoundaryOp *' with a newly created 'gsl::owner<>' [cppcoreguidelines-owning-memory]

add(new BoundaryDirichlet(), "dirichlet"); // Default ^

github-actions · 2026-07-08T00:33:42Z

 BoundaryFactory::BoundaryFactory() {
-  add(new BoundaryDirichlet(), "dirichlet");
+  add(new BoundaryDirichlet(), "dirichlet");       // Default
+  add(new BoundaryDirichlet_O1(), "dirichlet_o1"); // Old implementation in v3


warning: Potential memory leak [clang-analyzer-cplusplus.NewDeleteLeaks]

add(new BoundaryDirichlet_O1(), "dirichlet_o1"); // Old implementation in v3 ^

Additional context

src/mesh/boundary_factory.cxx:73: Assuming the condition is true

if (instance == nullptr) { ^

src/mesh/boundary_factory.cxx:73: Taking true branch

if (instance == nullptr) { ^

src/mesh/boundary_factory.cxx:75: Calling default constructor for 'BoundaryFactory'

instance = new BoundaryFactory(); ^

src/mesh/boundary_factory.cxx:22: Memory is allocated

add(new BoundaryDirichlet(), "dirichlet"); // Default ^

src/mesh/boundary_factory.cxx:23: Potential memory leak

add(new BoundaryDirichlet_O1(), "dirichlet_o1"); // Old implementation in v3 ^

github-actions · 2026-07-08T00:33:42Z

 BoundaryFactory::BoundaryFactory() {
-  add(new BoundaryDirichlet(), "dirichlet");
+  add(new BoundaryDirichlet(), "dirichlet");       // Default
+  add(new BoundaryDirichlet_O1(), "dirichlet_o1"); // Old implementation in v3


warning: initializing non-owner argument of type 'BoundaryOp *' with a newly created 'gsl::owner<>' [cppcoreguidelines-owning-memory]

add(new BoundaryDirichlet_O1(), "dirichlet_o1"); // Old implementation in v3 ^

github-actions · 2026-07-08T00:33:43Z

+  return new BoundaryDirichlet_O1(region, newgen);
+}
+
+void BoundaryDirichlet_O1::apply(Field2D& f) { BoundaryDirichlet_O1::apply(f, 0.); }


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

src/mesh/boundary_standard.cxx:0:

- #include <bout/boundary_standard.hxx> + #include "bout/field2d.hxx" + #include <bout/boundary_standard.hxx>

github-actions · 2026-07-08T00:33:43Z

+
+void BoundaryDirichlet_O1::apply(Field2D& f) { BoundaryDirichlet_O1::apply(f, 0.); }
+
+void BoundaryDirichlet_O1::apply(Field2D& f, BoutReal t) {


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

src/mesh/boundary_standard.cxx:0:

- #include <bout/boundary_standard.hxx> + #include "bout/bout_types.hxx" + #include <bout/boundary_standard.hxx>

github-actions · 2026-07-08T00:33:43Z

+  // Set (at 1st order) the value at the grid cell to the guard cells.
+
+  Mesh* mesh = bndry->localmesh;
+  ASSERT1(mesh == f.getMesh());


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

src/mesh/boundary_standard.cxx:0:

- #include <bout/boundary_standard.hxx> + #include "bout/assert.hxx" + #include <bout/boundary_standard.hxx>

github-actions · 2026-07-08T00:33:43Z

+
+  // Check for staggered grids
+
+  CELL_LOC loc = f.getLocation();


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

CELL_LOC loc = f.getLocation(); ^

github-actions · 2026-07-08T00:33:43Z

+
+  // Check for staggered grids
+
+  CELL_LOC loc = f.getLocation();


warning: variable 'loc' of type 'CELL_LOC' can be declared 'const' [misc-const-correctness]

Suggested change

CELL_LOC loc = f.getLocation();

CELL_LOC const loc = f.getLocation();

dschwoerer · 2026-07-08T07:19:07Z

* Implementation for staggered grids is not done.

Could you add an assert?

Also, please fix the clang-tidy and clang-format issues.

malamast · 2026-07-09T21:08:24Z

* Implementation for staggered grids is not done.
Could you add an assert?

Also, please fix the clang-tidy and clang-format issues.

I have this line here:

BOUT-dev/src/mesh/boundary_standard.cxx

Line 154 in a960447

    
           throw BoutException("dirichlet_o1 BC is not implementated for staggered grids.");

throw BoutException("neumann_o1 BC is not implementated for staggered grids.");
That throws an Exception if this BC is used with staggered grids. Does this BoutException work as an error message or a an assert statement?

Also, I used: git clang-format origin/next for the formatting. Is there another command I sue use for clang-tidy?

…tions

github-actions

clang-tidy made some suggestions

There were too many comments to post at once. Showing the first 25 out of 39. Check the log or trigger a new build to see more.

github-actions · 2026-07-23T00:26:53Z

-  add(new BoundaryDirichlet(), "dirichlet");
-  add(new BoundaryDirichlet(), "dirichlet_o2"); // Synonym for "dirichlet"
+  add(new BoundaryDirichlet(), "dirichlet");       // Default
+  add(new BoundaryDirichlet_O1(), "dirichlet_o1"); // Old implementation in v3


warning: Potential memory leak [clang-analyzer-cplusplus.NewDeleteLeaks]

add(new BoundaryDirichlet_O1(), "dirichlet_o1"); // Old implementation in v3 ^

Additional context

src/mesh/boundary_factory.cxx:74: Assuming the condition is true

if (instance == nullptr) { ^

src/mesh/boundary_factory.cxx:74: Taking true branch

if (instance == nullptr) { ^

src/mesh/boundary_factory.cxx:76: Calling default constructor for 'BoundaryFactory'

instance = new BoundaryFactory(); ^

src/mesh/boundary_factory.cxx:23: Memory is allocated

add(new BoundaryDirichlet(), "dirichlet"); // Default ^

src/mesh/boundary_factory.cxx:24: Potential memory leak

add(new BoundaryDirichlet_O1(), "dirichlet_o1"); // Old implementation in v3 ^

github-actions · 2026-07-23T00:26:53Z

-  add(new BoundaryDirichlet(), "dirichlet_o2"); // Synonym for "dirichlet"
+  add(new BoundaryDirichlet(), "dirichlet");       // Default
+  add(new BoundaryDirichlet_O1(), "dirichlet_o1"); // Old implementation in v3
+  add(new BoundaryDirichlet(), "dirichlet_o2");    // Synonym for "dirichlet"


warning: Potential memory leak [clang-analyzer-cplusplus.NewDeleteLeaks]

add(new BoundaryDirichlet(), "dirichlet_o2"); // Synonym for "dirichlet" ^

Additional context

src/mesh/boundary_factory.cxx:74: Assuming the condition is true

if (instance == nullptr) { ^

src/mesh/boundary_factory.cxx:74: Taking true branch

if (instance == nullptr) { ^

src/mesh/boundary_factory.cxx:76: Calling default constructor for 'BoundaryFactory'

instance = new BoundaryFactory(); ^

src/mesh/boundary_factory.cxx:24: Memory is allocated

add(new BoundaryDirichlet_O1(), "dirichlet_o1"); // Old implementation in v3 ^

src/mesh/boundary_factory.cxx:25: Potential memory leak

add(new BoundaryDirichlet(), "dirichlet_o2"); // Synonym for "dirichlet" ^

github-actions · 2026-07-23T00:26:53Z

-  add(new BoundaryDirichlet(), "dirichlet_o2"); // Synonym for "dirichlet"
+  add(new BoundaryDirichlet(), "dirichlet");       // Default
+  add(new BoundaryDirichlet_O1(), "dirichlet_o1"); // Old implementation in v3
+  add(new BoundaryDirichlet(), "dirichlet_o2");    // Synonym for "dirichlet"


warning: initializing non-owner argument of type 'BoundaryOp *' with a newly created 'gsl::owner<>' [cppcoreguidelines-owning-memory]

add(new BoundaryDirichlet(), "dirichlet_o2"); // Synonym for "dirichlet" ^

github-actions · 2026-07-23T00:26:53Z

+  add(new BoundaryDirichlet(), "dirichlet");       // Default
+  add(new BoundaryDirichlet_O1(), "dirichlet_o1"); // Old implementation in v3
+  add(new BoundaryDirichlet(), "dirichlet_o2");    // Synonym for "dirichlet"
  add(new BoundaryDirichlet_O3(), "dirichlet_o3");


warning: Potential memory leak [clang-analyzer-cplusplus.NewDeleteLeaks]

add(new BoundaryDirichlet_O3(), "dirichlet_o3"); ^

Additional context

src/mesh/boundary_factory.cxx:74: Assuming the condition is true

if (instance == nullptr) { ^

src/mesh/boundary_factory.cxx:74: Taking true branch

if (instance == nullptr) { ^

src/mesh/boundary_factory.cxx:76: Calling default constructor for 'BoundaryFactory'

instance = new BoundaryFactory(); ^

src/mesh/boundary_factory.cxx:25: Memory is allocated

add(new BoundaryDirichlet(), "dirichlet_o2"); // Synonym for "dirichlet" ^

src/mesh/boundary_factory.cxx:26: Potential memory leak

add(new BoundaryDirichlet_O3(), "dirichlet_o3"); ^

github-actions · 2026-07-23T00:26:53Z

-  add(new BoundaryNeumann(), "neumann");
-  add(new BoundaryNeumann(), "neumann_O2"); // Synonym for "neumann"
+
+  add(new BoundaryNeumann(), "neumann");       // Default


warning: Potential memory leak [clang-analyzer-cplusplus.NewDeleteLeaks]

add(new BoundaryNeumann(), "neumann"); // Default ^

Additional context

src/mesh/boundary_factory.cxx:74: Assuming the condition is true

if (instance == nullptr) { ^

src/mesh/boundary_factory.cxx:74: Taking true branch

if (instance == nullptr) { ^

src/mesh/boundary_factory.cxx:76: Calling default constructor for 'BoundaryFactory'

instance = new BoundaryFactory(); ^

src/mesh/boundary_factory.cxx:28: Memory is allocated

add(new BoundaryDirichlet_4thOrder(), "dirichlet_4thorder"); ^

src/mesh/boundary_factory.cxx:30: Potential memory leak

add(new BoundaryNeumann(), "neumann"); // Default ^

github-actions · 2026-07-23T00:26:54Z

+      for (int i = 1; i < bndry->width; i++) {
+        // Set any other guard cells using the values on the cells
+        int xi = bndry->x + i * bndry->bx;
+        int yi = bndry->y + i * bndry->by;


warning: variable 'yi' of type 'int' can be declared 'const' [misc-const-correctness]

int yi = bndry->y + i * bndry->by; ^

this fix will not be applied because it overlaps with another fix

github-actions · 2026-07-23T00:26:54Z

+        }
+      }
+    }
+  }


warning: do not use 'else' after 'throw' [readability-else-after-return]

Suggested change

}

} // Standard (non-staggered) case

for (; !bndry->isDone(); bndry->next1d()) {

for (int zk = mesh->zstart; zk <= mesh->zend; zk++) {

if (fg) {

val = fg->generate(Context(bndry, zk, loc, t, mesh));

}

f(bndry->x, bndry->y, zk) = val;

}

// This is not very efficient. Both boundary cells can be treated in one loop.

for (int i = 1; i < bndry->width; i++) {

// Set any other guard cells using the values on the cells

int xi = bndry->x + i * bndry->bx;

int yi = bndry->y + i * bndry->by;

for (int zk = mesh->zstart; zk <= mesh->zend; zk++) {

if (fg) {

val = fg->generate(Context(bndry, zk, loc, t, mesh));

}

f(xi, yi, zk) = val;

}

}

}

github-actions · 2026-07-23T00:26:54Z

+}
+
+void BoundaryDirichlet_O1::apply_ddt(Field3D& f) {
+  Mesh* mesh = bndry->localmesh;


warning: pointee of variable 'mesh' of type 'Mesh *' can be declared 'const' [misc-const-correctness]

Suggested change

Mesh* mesh = bndry->localmesh;

Mesh const* mesh = bndry->localmesh;

github-actions · 2026-07-23T00:26:54Z

+      // First argument should be an expression
+      newgen = FieldFactory::get()->parse(args.front());
+    }
+    return new BoundaryNeumann_O1(region, newgen);


warning: returning a newly created resource of type 'BoundaryOp *' or 'gsl::owner<>' from a function whose return type is not 'gsl::owner<>' [cppcoreguidelines-owning-memory]

return new BoundaryNeumann_O1(region, newgen); ^

github-actions · 2026-07-23T00:26:54Z

+
+    // Check for staggered grids
+
+    CELL_LOC loc = f.getLocation();


warning: variable 'loc' of type 'CELL_LOC' can be declared 'const' [misc-const-correctness]

Suggested change

CELL_LOC loc = f.getLocation();

CELL_LOC const loc = f.getLocation();

malamast added 3 commits July 7, 2026 16:39

boundary_standard: changed LocalNz to zend to make it compatible with…

a9a5f41

… the rest of the BC code. -This was a later change to the BCs

Apply clang-format

a960447

malamast requested a review from ZedThree July 8, 2026 00:30

malamast added feature backport candidiate Does not break backward compatibility, so can be back-ported to v4.4 labels Jul 8, 2026

github-actions Bot reviewed Jul 8, 2026

View reviewed changes

malamast added 2 commits July 22, 2026 17:01

Merge remote-tracking branch 'origin/next' into legacy-boundary-condi…

5bef26e

…tions

Apply perk-formatting

4687df8

github-actions Bot reviewed Jul 23, 2026

View reviewed changes


		void BoundaryDirichlet_O1::apply(Field2D& f) { BoundaryDirichlet_O1::apply(f, 0.); }

		void BoundaryDirichlet_O1::apply(Field2D& f, BoutReal t) {

	CELL_LOC loc = f.getLocation();
	CELL_LOC const loc = f.getLocation();

-  }
+  }     // Standard (non-staggered) case
+    for (; !bndry->isDone(); bndry->next1d()) {
+      for (int zk = mesh->zstart; zk <= mesh->zend; zk++) {
+        if (fg) {
+          val = fg->generate(Context(bndry, zk, loc, t, mesh));
+        }
+        f(bndry->x, bndry->y, zk) = val;
+      }
+      // This is not very efficient. Both boundary cells can be treated in one loop.
+      for (int i = 1; i < bndry->width; i++) {
+        // Set any other guard cells using the values on the cells
+        int xi = bndry->x + i * bndry->bx;
+        int yi = bndry->y + i * bndry->by;
+        for (int zk = mesh->zstart; zk <= mesh->zend; zk++) {
+          if (fg) {
+            val = fg->generate(Context(bndry, zk, loc, t, mesh));
+          }
+          f(xi, yi, zk) = val;
+        }
+      }
+    }

	Mesh* mesh = bndry->localmesh;
	Mesh const* mesh = bndry->localmesh;

Uh oh!

Conversation

malamast commented Jul 8, 2026 • edited by dschwoerer Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions Bot left a comment

Choose a reason for hiding this comment

Uh oh!

github-actions Bot Jul 8, 2026

Choose a reason for hiding this comment

Uh oh!

github-actions Bot Jul 8, 2026

Choose a reason for hiding this comment

Uh oh!

github-actions Bot Jul 8, 2026

Choose a reason for hiding this comment

Uh oh!

github-actions Bot Jul 8, 2026

Choose a reason for hiding this comment

Uh oh!

github-actions Bot Jul 8, 2026

Choose a reason for hiding this comment

Uh oh!

github-actions Bot Jul 8, 2026

Choose a reason for hiding this comment

Uh oh!

github-actions Bot Jul 8, 2026

Choose a reason for hiding this comment

Uh oh!

github-actions Bot Jul 8, 2026

Choose a reason for hiding this comment

Uh oh!

github-actions Bot Jul 8, 2026

Choose a reason for hiding this comment

Uh oh!

github-actions Bot Jul 8, 2026

Choose a reason for hiding this comment

Uh oh!

dschwoerer commented Jul 8, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

malamast commented Jul 9, 2026

Uh oh!

github-actions Bot left a comment

Choose a reason for hiding this comment

Uh oh!

github-actions Bot Jul 23, 2026

Choose a reason for hiding this comment

Uh oh!

github-actions Bot Jul 23, 2026

Choose a reason for hiding this comment

Uh oh!

github-actions Bot Jul 23, 2026

Choose a reason for hiding this comment

Uh oh!

github-actions Bot Jul 23, 2026

Choose a reason for hiding this comment

Uh oh!

github-actions Bot Jul 23, 2026

Choose a reason for hiding this comment

Uh oh!

github-actions Bot Jul 23, 2026

Choose a reason for hiding this comment

Uh oh!

github-actions Bot Jul 23, 2026

Choose a reason for hiding this comment

Uh oh!

github-actions Bot Jul 23, 2026

Choose a reason for hiding this comment

Uh oh!

github-actions Bot Jul 23, 2026

Choose a reason for hiding this comment

Uh oh!

github-actions Bot Jul 23, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

malamast commented Jul 8, 2026 •

edited by dschwoerer

Loading

dschwoerer commented Jul 8, 2026 •

edited

Loading