Skip to content

Commit 8c15ba7

Browse files
committed
wording
1 parent f20dced commit 8c15ba7

File tree

4 files changed

+7
-4
lines changed

4 files changed

+7
-4
lines changed

docs/website/01_framework/dirichletBCs.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@ const auto& basis() const; // (5)!
2929
bool isConstrained(std::size_t i) const; // (6)!
3030
auto fixedDOFsize() const; // (7)!
3131
auto size() const ; // (8)!
32+
auto reset(); // (9)!
3233
```
3334
3435
1. Create class by inserting a global basis, [@sander2020dune] Chapter 10.
@@ -42,5 +43,6 @@ auto size() const ; // (8)!
4243
6. Indicates whether the degree of freedom `i` is fixed.
4344
7. Returns the number of fixed degrees of freedom.
4445
8. Returns the number of all dirichlet degrees of freedom.
46+
9. Resets the whole container
4547
4648
\bibliography

ikarus/python/dirichletvalues/dirichletvalues.hh

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,8 @@ void forwardCorrectFunction(DirichletValues& dirichletValues, const pybind11::fu
8787
* - `fixDOFs(f)`: Fixes boundary degrees of freedom using a user-defined function `f` with the basis and the boolean
8888
* vector as arguments.
8989
* - `setSingleDOF(i, flag: bool): Fixes or unfixes DOF with index i
90-
* - `isConstrained(i)`: Checks wether index i is constrained
90+
* - `isConstrained(i)`: Checks whether index i is constrained
91+
* - `reset()`: Resets the whole container
9192
*
9293
* The following properties can be accessed:
9394
* - `container`: the underlying container of dirichlet flags (as a const reference)

ikarus/python/test/testdirichletvalues.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ def fixTopSide(vec, localIndex, localView, intersection):
7171
indicesPerDirection: int = (math.sqrt(grid.size(0)) + 1) * 2
7272
assert dirichletValues.fixedDOFsize == 2 + indicesPerDirection
7373

74-
# This checks wether container is a reference
74+
# This checks whether container is a reference
7575
assert sum(container) == dirichletValues.fixedDOFsize
7676

7777
# Test Subbasis

ikarus/utils/dirichletvalues.hh

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@ public:
104104
* \brief Fixes (set boolean value to true) a specific degree of freedom
105105
*
106106
* \param i An index indicating the DOF number to be fixed
107-
* \param flag Boolean indicating wether the DOF should fixed or not
107+
* \param flag Boolean indicating whether the DOF should fixed or not
108108
*/
109109
template <typename MultiIndex>
110110
requires(not std::integral<MultiIndex>)
@@ -116,7 +116,7 @@ public:
116116
* \brief Fixes (set boolean value to true) a specific degree of freedom
117117
*
118118
* \param i An index indicating the DOF number to be fixed
119-
* \param flag Boolean indicating wether the DOF should fixed or not
119+
* \param flag Boolean indicating whether the DOF should fixed or not
120120
*/
121121
void setSingleDOF(std::size_t i, bool flag) { dirichletFlags_[i] = flag; }
122122

0 commit comments

Comments
 (0)