Merge pull request #3699 from blattms/man-page-spelling

Adds manpage and fixes several spelling issue found by lintian

opm/core/props/satfunc/RelpermDiagnostics.cpp

@@ -326,7 +326,7 @@ namespace Opm{
         }
 
         if (krg.front() > 1.0 || krg.back() < 0) {
-            const std::string msg = "In SLGOF table SATNUM = " + regionIdx + ", krg shoule be in range [0, 1].";
+            const std::string msg = "In SLGOF table SATNUM = " + regionIdx + ", krg should be in range [0, 1].";
             OpmLog::error(msg);
         }
         if (krg.back() != 0.0) {

opm/simulators/flow/BlackoilModelEbos.hpp

@@ -267,7 +267,7 @@ namespace Opm {
             std::fill(wasSwitched_.begin(), wasSwitched_.end(), false);
 
             if (param_.update_equations_scaling_) {
-                std::cout << "equation scaling not suported yet" << std::endl;
+                std::cout << "equation scaling not supported yet" << std::endl;
                 //updateEquationsScaling();
             }
             report.pre_post_time += perfTimer.stop();

opm/simulators/linalg/FlowLinearSolverParameters.hpp

@@ -304,8 +304,8 @@ namespace Opm
             EWOMS_REGISTER_PARAM(TypeTag, int, LinearSolverRestart, "The number of iterations after which GMRES is restarted");
             EWOMS_REGISTER_PARAM(TypeTag, int, FlowLinearSolverVerbosity, "The verbosity level of the linear solver (0: off, 2: all)");
             EWOMS_REGISTER_PARAM(TypeTag, int, IluFillinLevel, "The fill-in level of the linear solver's ILU preconditioner");
-            EWOMS_REGISTER_PARAM(TypeTag, std::string, MiluVariant, "Specify which variant of the modified-ILU preconditioner ought to be used. Possible variants are: ILU (default, plain ILU), MILU_1 (lump diagonal with dropped row entries), MILU_2 (lump diagonal with the sum of the absolute values of the dropped row  entries), MILU_3 (if diagonal is positive add sum of dropped row entrires. Otherwise substract them), MILU_4 (if diagonal is positive add sum of dropped row entrires. Otherwise do nothing");
-            EWOMS_REGISTER_PARAM(TypeTag, bool, IluRedblack, "Use red-black partioning for the ILU preconditioner");
+            EWOMS_REGISTER_PARAM(TypeTag, std::string, MiluVariant, "Specify which variant of the modified-ILU preconditioner ought to be used. Possible variants are: ILU (default, plain ILU), MILU_1 (lump diagonal with dropped row entries), MILU_2 (lump diagonal with the sum of the absolute values of the dropped row  entries), MILU_3 (if diagonal is positive add sum of dropped row entrires. Otherwise subtract them), MILU_4 (if diagonal is positive add sum of dropped row entrires. Otherwise do nothing");
+            EWOMS_REGISTER_PARAM(TypeTag, bool, IluRedblack, "Use red-black partitioning for the ILU preconditioner");
             EWOMS_REGISTER_PARAM(TypeTag, bool, IluReorderSpheres, "Whether to reorder the entries of the matrix in the red-black ILU preconditioner in spheres starting at an edge. If false the original ordering is preserved in each color. Otherwise why try to ensure D4 ordering (in a 2D structured grid, the diagonal elements are consecutive).");
             EWOMS_REGISTER_PARAM(TypeTag, bool, UseGmres, "Use GMRES as the linear solver");
             EWOMS_REGISTER_PARAM(TypeTag, bool, LinearSolverRequireFullSparsityPattern, "Produce the full sparsity pattern for the linear solver");

opm/simulators/linalg/ParallelOverlappingILU0.hpp

@@ -1058,7 +1058,7 @@ public:
         catch (const Dune::MatrixBlockError& error)
         {
             message = error.what();
-            std::cerr<<"Exception occured on process " << rank << " during " <<
+            std::cerr<<"Exception occurred on process " << rank << " during " <<
                 "setup of ILU0 preconditioner with message: " <<
                 message<<std::endl;
             ilu_setup_successful = 0;

opm/simulators/linalg/bda/FPGABILU0.cpp

@@ -293,7 +293,7 @@ bool FPGABILU0<block_size>::create_preconditioner(BlockedMatrix<block_size> *mat
             jRowEnd = LUMat->rowPointers[j + 1];
             jk = diagIndex[j] + 1;
             ik = ij + 1;
-            // substract that row scaled by the pivot from this row.
+            // subtract that row scaled by the pivot from this row.
             while (ik < iRowEnd && jk < jRowEnd) {
                 if (LUMat->colIndices[ik] == LUMat->colIndices[jk]) {
                     blockMultSub<bs>(LUMat->nnzValues + ik * bs * bs, pivot, LUMat->nnzValues + jk * bs * bs);

opm/simulators/linalg/bda/openclKernels.cpp

@@ -941,7 +941,7 @@ void OpenclKernels::apply_stdwells_no_reorder(cl::Buffer& d_Cnnzs_ocl, cl::Buffe
                         int jRowEnd = LUrows[j + 1];
                         int jk = diagIndex[j] + 1;
                         int ik = ij + 1;
-                        // substract that row scaled by the pivot from this row.
+                        // subtract that row scaled by the pivot from this row.
                         while (ik < iRowEnd && jk < jRowEnd) {
                             if (LUcols[ik] == LUcols[jk]) {
                                 block_mult_sub(LUvals + ik * bs * bs, pivot + lmem_offset, LUvals + jk * bs * bs);

opm/simulators/wells/BlackoilWellModel.hpp

@@ -244,7 +244,7 @@ namespace Opm {
                 return wsrpt;
             }
 
-            // substract Binv(D)rw from r;
+            // subtract Binv(D)rw from r;
             void apply( BVector& r) const;
 
             // subtract B*inv(D)*C * x from A*x

opm/simulators/wells/BlackoilWellModelGeneric.cpp

@@ -1091,7 +1091,7 @@ checkGconsaleLimits(const Group& group,
     double sales_rate = production_rate - injection_rate;
     double production_target = gconsale.sales_target + injection_rate;
 
-    // add import rate and substract consumption rate for group for gas
+    // add import rate and subtract consumption rate for group for gas
     if (schedule()[reportStepIdx].gconsump().has(group.name())) {
         const auto& gconsump = schedule()[reportStepIdx].gconsump().get(group.name(), summaryState_);
         if (phase_usage_.phase_used[BlackoilPhases::Vapour]) {

opm/simulators/wells/GasLiftStage2.cpp

@@ -932,7 +932,7 @@ getEcoGradients(std::vector<GradPair> &inc_grads, std::vector<GradPair> &dec_gra
 
 // Recalculate gradients (and related information, see struct GradInfo in
 //   GasLiftSingleWell.hpp) after an ALQ increment
-//   has been given from the well with minumum decremental gradient (represented
+//   has been given from the well with minimum decremental gradient (represented
 //   by the input argument min_dec_grad_itr) to the well with the largest
 //   incremental gradient (represented by input argument max_inc_grad_itr).
 //

opm/simulators/wells/WellGroupHelpers.cpp

@@ -642,7 +642,7 @@ namespace WellGroupHelpers
             rein[phase] = sumWellPhaseRates(false, group, schedule, wellState, reportStepIdx, phase, /*isInjector*/ false);
         }
 
-        // add import rate and substract consumption rate for group for gas
+        // add import rate and subtract consumption rate for group for gas
         if (schedule[reportStepIdx].gconsump().has(group.name())) {
             const auto& gconsump = schedule[reportStepIdx].gconsump().get(group.name(), st);
             if (pu.phase_used[BlackoilPhases::Vapour]) {

opm/simulators/wells/WellInterfaceGeneric.cpp

@@ -338,7 +338,7 @@ bool WellInterfaceGeneric::isVFPActive(DeferredLogger& deferred_logger) const
             if (vfp_properties_->getProd()->hasTable(table_id)) {
                 return true;
             } else {
-                OPM_DEFLOG_THROW(std::runtime_error, "VFPPROD table " << std::to_string(table_id) << " is specfied,"
+                OPM_DEFLOG_THROW(std::runtime_error, "VFPPROD table " << std::to_string(table_id) << " is specified,"
                               << " for well " << name() << ", while we could not access it during simulation", deferred_logger);
             }
         }
@@ -351,7 +351,7 @@ bool WellInterfaceGeneric::isVFPActive(DeferredLogger& deferred_logger) const
             if (vfp_properties_->getInj()->hasTable(table_id)) {
                 return true;
             } else {
-                OPM_DEFLOG_THROW(std::runtime_error, "VFPINJ table " << std::to_string(table_id) << " is specfied,"
+                OPM_DEFLOG_THROW(std::runtime_error, "VFPINJ table " << std::to_string(table_id) << " is specified,"
                               << " for well " << name() << ", while we could not access it during simulation", deferred_logger);
             }
         }