fix docs and styles

Author: Nijat Nazim Rustamov

doc/content/source/tensor_computes/LBMFixedFirstOrderBC.md

@@ -1,22 +1,18 @@
-# LBMFixedFirstOrderBC9Q
+# LBMFixedFirstOrderBC
 
-!syntax description /TensorComputes/Solve/LBMFixedFirstOrderBC9Q
+!syntax description /TensorComputes/Solve/LBMFixedFirstOrderBC
 
-LBMFixedFirstOrderBC implements Zou\-He velocity boundary conditions at the inlet and outlet for D2Q9, D3Q19 and D3Q27 stencils. The choice of stencil should be indicated in the name of the compute object such as LBMFixedFirstOrderBC9Q for D2Q9.
+LBMFixedFirstOrderBC implements Zou\-He velocity boundary conditions at the inlet and outlet for D2Q9, D3Q19 and D3Q27 stencils.
 
 ## Overview
 
 Enforces first\-order accurate macroscopic velocity at selected domain faces via Zou\-He formulas.
-Choose faces with [!param](/TensorComputes/Solve/LBMFixedFirstOrderBC9Q/boundary) and provide
+Choose faces with [!param](/TensorComputes/Solve/LBMFixedFirstOrderBC/boundary) and provide
 macroscopic fields as required by the implementation.
 
 ## Example Input File Syntax
 
 !listing test/tests/lbm/vertical_velocity_bcs.i block=TensorComputes/Boundary/top
 !listing test/tests/lbm/vertical_velocity_bcs.i block=TensorComputes/Boundary/bottom
 
-!syntax parameters /TensorComputes/Solve/LBMFixedFirstOrderBC9Q
-
-!syntax inputs /TensorComputes/Solve/LBMFixedFirstOrderBC9Q
-
-!syntax children /TensorComputes/Solve/LBMFixedFirstOrderBC9Q
+!syntax parameters /TensorComputes/Solve/LBMFixedFirstOrderBC

doc/content/source/tensor_computes/LBMFixedZerothOrderBC.md

@@ -1,22 +1,18 @@
-# LBMFixedZerothOrderBC9Q
+# LBMFixedZerothOrderBC
 
-!syntax description /TensorComputes/Solve/LBMFixedZerothOrderBC9Q
+!syntax description /TensorComputes/Solve/LBMFixedZerothOrderBC
 
-LBMFixedZerothOrderBC implements Zou-He pressure boundary conditions at the inlet and outlet for D2Q9, D3Q19 and D3Q27 stencils. The choice of stencil should be indicated in the name of the compute object such as LBMFixedZerothOrderBC9Q for D2Q9.
+LBMFixedZerothOrderBC implements Zou-He pressure boundary conditions at the inlet and outlet for D2Q9, D3Q19 and D3Q27 stencils.
 
 ## Overview
 
-LBMFixedZerothOrderBC implements Zou\-He pressure boundary conditions at the inlet and outlet for D2Q9, D3Q19 and D3Q27 stencils. The choice of stencil should be indicated in the name of the compute object such as LBMFixedZerothOrderBC9Q for D2Q9.
-Choose faces with [!param](/TensorComputes/Solve/LBMFixedZerothOrderBC9Q/boundary) and provide macroscopic fields as
+LBMFixedZerothOrderBC implements Zou\-He pressure boundary conditions at the inlet and outlet for D2Q9, D3Q19 and D3Q27 stencils.
+Choose faces with [!param](/TensorComputes/Solve/LBMFixedZerothOrderBC/boundary) and provide macroscopic fields as
 required by the implementation.
 
 ## Example Input File Syntax
 
 !listing test/tests/lbm/vertical_density_bcs.i block=TensorComputes/Boundary/top
 !listing test/tests/lbm/vertical_density_bcs.i block=TensorComputes/Boundary/bottom
 
-!syntax parameters /TensorComputes/Solve/LBMFixedZerothOrderBC9Q
-
-!syntax inputs /TensorComputes/Solve/LBMFixedZerothOrderBC9Q
-
-!syntax children /TensorComputes/Solve/LBMFixedZerothOrderBC9Q
+!syntax parameters /TensorComputes/Solve/LBMFixedZerothOrderBC

src/tensor_computes/LBMFixedFirstOrderBC.C

@@ -42,7 +42,8 @@ LBMFixedFirstOrderBC::frontBoundary()
   if (_domain.getDim() == 2)
     mooseError("There is no front boundary in 2 dimensions.");
   else
-    mooseError("Front boundary is not implemented, but it can be replaced by any other boundary by rotating the domain.");
+    mooseError("Front boundary is not implemented, but it can be replaced by any other boundary by "
+               "rotating the domain.");
 }
 
 void
@@ -51,7 +52,8 @@ LBMFixedFirstOrderBC::backBoundary()
   if (_domain.getDim() == 2)
     mooseError("There is no back boundary in 2 dimensions.");
   else
-    mooseError("Back boundary is not implemented, but it can be replaced by any other boundary by rotating the domain.");
+    mooseError("Back boundary is not implemented, but it can be replaced by any other boundary by "
+               "rotating the domain.");
 }
 
 void
@@ -106,7 +108,7 @@ LBMFixedFirstOrderBC::leftBoundary()
   {
     torch::Tensor density = 1.0 / (1.0 - _value) *
                             (torch::sum(_f.index({0, Slice(), Slice(), -_stencil._neutral_x}), -1) +
-                            2 * torch::sum(_f.index({0, Slice(), Slice(), _stencil._right}), -1));
+                             2 * torch::sum(_f.index({0, Slice(), Slice(), _stencil._right}), -1));
 
     _u.index_put_({0, Slice(), Slice(), _stencil._left[0]},
                   _f.index({0, Slice(), Slice(), _stencil._right[0]}) +
@@ -128,9 +130,9 @@ LBMFixedFirstOrderBC::rightBoundaryD2Q9()
 {
   torch::Tensor density = 1.0 / (1.0 + _value) *
                           (_f.index({_grid_size[0] - 1, Slice(), Slice(), 0}) +
-                          _f.index({_grid_size[0] - 1, Slice(), Slice(), 2}) +
-                          _f.index({_grid_size[0] - 1, Slice(), Slice(), 4}) +
-                          2 * (_f.index({_grid_size[0] - 1, Slice(), Slice(), 1}) +
+                           _f.index({_grid_size[0] - 1, Slice(), Slice(), 2}) +
+                           _f.index({_grid_size[0] - 1, Slice(), Slice(), 4}) +
+                           2 * (_f.index({_grid_size[0] - 1, Slice(), Slice(), 1}) +
                                 _f.index({_grid_size[0] - 1, Slice(), Slice(), 5}) +
                                 _f.index({_grid_size[0] - 1, Slice(), Slice(), 8})));
 
@@ -148,7 +150,7 @@ LBMFixedFirstOrderBC::rightBoundaryD2Q9()
                   _f.index({_grid_size[0] - 1, Slice(), Slice(), _stencil._left[i]}) +
                       0.5 * _stencil._ey[opposite_dir] *
                           (_f.index({_grid_size[0] - 1, Slice(), Slice(), 4}) -
-                          _f.index({_grid_size[0] - 1, Slice(), Slice(), 2})) -
+                           _f.index({_grid_size[0] - 1, Slice(), Slice(), 2})) -
                       1.0 / 6.0 * density * _value);
   }
 }
@@ -163,7 +165,7 @@ LBMFixedFirstOrderBC::rightBoundary()
     torch::Tensor density =
         1.0 / (1.0 + _value) *
         (torch::sum(_f.index({_grid_size[0] - 1, Slice(), Slice(), -_stencil._neutral_x}), -1) +
-        2 * torch::sum(_f.index({_grid_size[0] - 1, Slice(), Slice(), _stencil._left}), -1));
+         2 * torch::sum(_f.index({_grid_size[0] - 1, Slice(), Slice(), _stencil._left}), -1));
 
     _u.index_put_({_grid_size[0] - 1, Slice(), Slice(), _stencil._right[0]},
                   _f.index({_grid_size[0] - 1, Slice(), Slice(), _stencil._left[0]}) -
@@ -214,7 +216,8 @@ LBMFixedFirstOrderBC::bottomBoundary()
   if (_stencil._q == 9)
     bottomBoundaryD2Q9();
   else
-    mooseError("Bottom boundary is not implemented, but it can be replaced by another boundary by rotating the domain.");
+    mooseError("Bottom boundary is not implemented, but it can be replaced by another boundary by "
+               "rotating the domain.");
 }
 
 void
@@ -253,7 +256,8 @@ LBMFixedFirstOrderBC::topBoundary()
   if (_stencil._q == 9)
     topBoundaryD2Q9();
   else
-    mooseError("Top boundary is not implemented, but it can be replaced by another boundary by rotating the domain.");
+    mooseError("Top boundary is not implemented, but it can be replaced by another boundary by "
+               "rotating the domain.");
 }
 
 void

src/tensor_computes/LBMFixedZerothOrderBC.C

@@ -24,8 +24,7 @@ LBMFixedZerothOrderBC::validParams()
   return params;
 }
 
-LBMFixedZerothOrderBC::LBMFixedZerothOrderBC(
-    const InputParameters & parameters)
+LBMFixedZerothOrderBC::LBMFixedZerothOrderBC(const InputParameters & parameters)
   : LBMBoundaryCondition(parameters),
     _f(getInputBufferByName(getParam<TensorInputBufferName>("f"))),
     _grid_size(_lb_problem.getGridSize()),
@@ -39,7 +38,8 @@ LBMFixedZerothOrderBC::frontBoundary()
   if (_domain.getDim() == 2)
     mooseError("There is no front boundary in 2 dimensions.");
   else
-    mooseError("Front boundary is not implemented, but it can be replaced by any other boundary by rotating the domain.");
+    mooseError("Front boundary is not implemented, but it can be replaced by any other boundary by "
+               "rotating the domain.");
 }
 
 void
@@ -48,7 +48,8 @@ LBMFixedZerothOrderBC::backBoundary()
   if (_domain.getDim() == 2)
     mooseError("There is no back boundary in 2 dimensions.");
   else
-    mooseError("Back boundary is not implemented, but it can be replaced by any other boundary by rotating the domain.");
+    mooseError("Back boundary is not implemented, but it can be replaced by any other boundary by "
+               "rotating the domain.");
 }
 
 void
@@ -86,9 +87,9 @@ LBMFixedZerothOrderBC::leftBoundary()
     leftBoundaryD2Q9();
   else
   {
-     torch::Tensor velocity =
+    torch::Tensor velocity =
         1.0 - (torch::sum(_f.index({0, Slice(), Slice(), -_stencil._neutral_x}), -1) +
-              2 * torch::sum(_f.index({0, Slice(), Slice(), _stencil._right}), -1)) /
+               2 * torch::sum(_f.index({0, Slice(), Slice(), _stencil._right}), -1)) /
                   _value;
 
     _u.index_put_({0, Slice(), Slice(), _stencil._left[0]},
@@ -102,9 +103,8 @@ LBMFixedZerothOrderBC::leftBoundary()
                     _f.index({0, Slice(), Slice(), _stencil._right[i]}) +
                         2.0 * _stencil._weights[_stencil._left[i]] / _lb_problem._cs2 * _value *
                             velocity);
-    }    
+    }
   }
-
 }
 
 void
@@ -145,11 +145,11 @@ LBMFixedZerothOrderBC::rightBoundary()
     rightBoundaryD2Q9();
   else
   {
-     torch::Tensor velocity =
-      (torch::sum(_f.index({_grid_size[0] - 1, Slice(), Slice(), -_stencil._neutral_x}), -1) +
-       2 * torch::sum(_f.index({_grid_size[0] - 1, Slice(), Slice(), _stencil._left}), -1)) /
-          _value -
-      1.0;
+    torch::Tensor velocity =
+        (torch::sum(_f.index({_grid_size[0] - 1, Slice(), Slice(), -_stencil._neutral_x}), -1) +
+         2 * torch::sum(_f.index({_grid_size[0] - 1, Slice(), Slice(), _stencil._left}), -1)) /
+            _value -
+        1.0;
 
     _u.index_put_({_grid_size[0] - 1, Slice(), Slice(), _stencil._right[0]},
                   _f.index({_grid_size[0] - 1, Slice(), Slice(), _stencil._left[0]}) -
@@ -201,7 +201,8 @@ LBMFixedZerothOrderBC::bottomBoundary()
   if (_stencil._q == 9)
     bottomBoundaryD2Q9();
   else
-    mooseError("Bottom boundary is not implemented, but it can be replaced by any other boundary by rotating the domain");
+    mooseError("Bottom boundary is not implemented, but it can be replaced by any other boundary "
+               "by rotating the domain");
 }
 
 void
@@ -242,7 +243,8 @@ LBMFixedZerothOrderBC::topBoundary()
   if (_stencil._q == 9)
     topBoundaryD2Q9();
   else
-    mooseError("Top boundary is not implemented, but it can be replaced by any other boundary by rotating the domain");
+    mooseError("Top boundary is not implemented, but it can be replaced by any other boundary by "
+               "rotating the domain");
 }
 
 void