Skip to content

Commit

Permalink
Merge branch 'develop' into addslurm
Browse files Browse the repository at this point in the history
  • Loading branch information
prudhomm authored Jan 6, 2025
2 parents b768ed8 + a3c9472 commit c4eb32a
Show file tree
Hide file tree
Showing 6 changed files with 691 additions and 4 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ on:

jobs:
build:
runs-on: self-ubuntu-22.04
runs-on: self-ubuntu-24.04
steps:
- uses: actions/checkout@v4
with:
Expand Down
24 changes: 21 additions & 3 deletions docs/dev/modules/reference/pages/codingrules.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -172,7 +172,9 @@ public:
private:
//! member
int member;
int M_member;
//! another member
int member_;
};
//! the function
Expand Down Expand Up @@ -231,14 +233,16 @@ class MeshAdaptation {};
----

* Non-static data members name of structures and classes always start with `M_` . M stands for Member. The rational behind this is for example :
* Non-static data members name of structures and classes always start with `M_` . M stands for Member, or adding `_` at the end of the member name. The rational behind this is for example :
** to be able to immediately see that the data is a member of a class or a struct
** to easily search and query-replace

[source,cpp]
----
// Wong
class meshAdaptation { std::vector directions; };
// Wrong
// Correct
class meshAdaptation { std::vector directions_; };
// Correct
Expand All @@ -252,6 +256,8 @@ class MeshAdaptation { std::vector M_directions; };

[source,cpp]
----
// Wrong
class meshAdaptation { static std::vector directions; };
// Wrong
class meshAdaptation { static std::vector directions_; };
Expand Down Expand Up @@ -356,7 +362,19 @@ if (address.isEmpty() || !isValid() || !codec)
{
return false;
}
else
{
return true;
}
// Wrong
if (address.isEmpty() || !isValid() || !codec) {
return false;
}
else {
return truel
}
----

* Exception 2: Use braces also in if-then-else blocks where either the if-code or the else-code covers several lines
Expand Down
1 change: 1 addition & 0 deletions docs/math/antora.yml
Original file line number Diff line number Diff line change
Expand Up @@ -21,3 +21,4 @@ nav:
- modules/fem/nav.adoc
- modules/hdg/nav.adoc
- modules/rbm/nav.adoc
- modules/solver/nav.adoc
2 changes: 2 additions & 0 deletions docs/math/modules/solver/nav.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
// -*- mode: adoc -*-
* xref:index.adoc[Algebraic Solutions]
Loading

0 comments on commit c4eb32a

Please sign in to comment.