Move setting of fine scale velocity

to a dedicated method and use const reference instead of shared pointer
Introduce a method that checks when to set the fine scale velocity,
based on the checks that have been there already

Author: c-p-schmidt

src/elch/4C_elch_moving_boundary_algorithm.cpp

@@ -112,8 +112,7 @@ void ElCh::MovingBoundaryAlgorithm::time_loop()
   {
     // transfer convective velocity = fluid velocity - grid velocity
     scatra_field()->set_convective_velocity(*fluid_field()->convective_vel());
-    scatra_field()->set_velocity_field(
-        fluid_field()->hist(), fluid_field()->convective_vel(), nullptr);
+    scatra_field()->set_velocity_field(fluid_field()->hist(), fluid_field()->convective_vel());
   }
 
   // transfer moving mesh data
@@ -267,8 +266,7 @@ void ElCh::MovingBoundaryAlgorithm::solve_scatra()
       {
         // transfer convective velocity = fluid velocity - grid velocity
         scatra_field()->set_convective_velocity(*fluid_field()->convective_vel());
-        scatra_field()->set_velocity_field(
-            fluid_field()->hist(), fluid_field()->convective_vel(), nullptr);
+        scatra_field()->set_velocity_field(fluid_field()->hist(), fluid_field()->convective_vel());
       }
     }
     break;

src/fs3i/4C_fs3i_fps3i_partitioned.cpp

@@ -652,7 +652,7 @@ void FS3I::PartFPS3I::set_velocity_fields()
       for (unsigned i = 0; i < scatravec_.size(); ++i)
       {
         scatravec_[i]->scatra_field()->set_convective_velocity(*convel[i]);
-        scatravec_[i]->scatra_field()->set_velocity_field(nullptr, vel[i], nullptr);
+        scatravec_[i]->scatra_field()->set_velocity_field(nullptr, vel[i]);
       }
       break;
     }

src/fs3i/4C_fs3i_partitioned.cpp

@@ -705,7 +705,7 @@ void FS3I::PartFS3I::set_velocity_fields() const
     scatravec_[i]->scatra_field()->set_convective_velocity(
         *vol_mortar_master_to_slavei(i, convel[i]));
     scatravec_[i]->scatra_field()->set_velocity_field(
-        nullptr, vol_mortar_master_to_slavei(i, vel[i]), nullptr);
+        nullptr, vol_mortar_master_to_slavei(i, vel[i]));
   }
 }
 

src/loma/4C_loma_algorithm.cpp

@@ -313,7 +313,11 @@ void LowMach::Algorithm::initial_calculations()
 {
   // set initial velocity field for evaluation of initial scalar time derivative in SCATRA
   scatra_field()->set_convective_velocity(*fluid_field()->velnp());
-  scatra_field()->set_velocity_field(nullptr, fluid_field()->velnp(), fluid_field()->fs_vel());
+  scatra_field()->set_velocity_field(nullptr, fluid_field()->velnp());
+  if (scatra_field()->fine_scale_velocity_field_required())
+  {
+    scatra_field()->set_fine_scale_velocity(*fluid_field()->fs_vel());
+  }
 
   // set initial value of thermodynamic pressure in SCATRA
   std::dynamic_pointer_cast<ScaTra::ScaTraTimIntLoma>(scatra_field())->set_initial_therm_pressure();
@@ -540,16 +544,24 @@ void LowMach::Algorithm::set_fluid_values_in_scatra()
     case Inpar::FLUID::timeint_afgenalpha:
     {
       scatra_field()->set_convective_velocity(*fluid_field()->velaf());
-      scatra_field()->set_velocity_field(
-          fluid_field()->accam(), fluid_field()->velaf(), fluid_field()->fs_vel());
+      scatra_field()->set_velocity_field(fluid_field()->accam(), fluid_field()->velaf());
+      if (scatra_field()->fine_scale_velocity_field_required() and
+          fluid_field()->fs_vel() != nullptr)
+      {
+        scatra_field()->set_fine_scale_velocity(*fluid_field()->fs_vel());
+      }
     }
     break;
     case Inpar::FLUID::timeint_one_step_theta:
     case Inpar::FLUID::timeint_bdf2:
     {
       scatra_field()->set_convective_velocity(*fluid_field()->velnp());
-      scatra_field()->set_velocity_field(
-          fluid_field()->hist(), fluid_field()->velnp(), fluid_field()->fs_vel());
+      scatra_field()->set_velocity_field(fluid_field()->hist(), fluid_field()->velnp());
+      if (scatra_field()->fine_scale_velocity_field_required() and
+          fluid_field()->fs_vel() != nullptr)
+      {
+        scatra_field()->set_fine_scale_velocity(*fluid_field()->fs_vel());
+      }
     }
     break;
     default:

src/poroelast_scatra/4C_poroelast_scatra_base.cpp

@@ -180,7 +180,7 @@ void PoroElastScaTra::PoroScatraBase::set_velocity_fields()
   }
 
   scatra_->scatra_field()->set_convective_velocity(*convel);
-  scatra_->scatra_field()->set_velocity_field(nullptr, velnp, nullptr);
+  scatra_->scatra_field()->set_velocity_field(nullptr, velnp);
 }
 
 /*----------------------------------------------------------------------*

src/scatra/4C_scatra_algorithm.cpp

@@ -235,7 +235,7 @@ void ScaTra::ScaTraAlgorithm::prepare_time_step_convection()
   if (step() == 1)
   {
     scatra_field()->set_convective_velocity(*fluid_field()->velnp());
-    scatra_field()->set_velocity_field(fluid_field()->hist(), fluid_field()->velnp(), nullptr);
+    scatra_field()->set_velocity_field(fluid_field()->hist(), fluid_field()->velnp());
   }
 
   // prepare time step (+ initialize one-step-theta scheme correctly with
@@ -293,21 +293,19 @@ void ScaTra::ScaTraAlgorithm::set_velocity_field()
   //       since it is not yet clear how the grid velocity should be interpolated
   //       properly -> hence, ScaTraAlgorithm does not support moving
   //       meshes yet
-
-  // this is ugly, but FsVel() may give a Null pointer which we canNOT give to the volmortart
-  // framework
-  // TODO (thon): make this somehow prettier..
-  std::shared_ptr<const Core::LinAlg::Vector<double>> fsvel = fluid_field()->fs_vel();
-  if (fsvel != nullptr) fsvel = fluid_to_scatra(fsvel);
-
   switch (fluid_field()->tim_int_scheme())
   {
     case Inpar::FLUID::timeint_npgenalpha:
     case Inpar::FLUID::timeint_afgenalpha:
     {
       scatra_field()->set_convective_velocity(*fluid_to_scatra(fluid_field()->velaf()));
       scatra_field()->set_velocity_field(
-          fluid_to_scatra(fluid_field()->accam()), fluid_to_scatra(fluid_field()->velaf()), fsvel);
+          fluid_to_scatra(fluid_field()->accam()), fluid_to_scatra(fluid_field()->velaf()));
+      if (scatra_field()->fine_scale_velocity_field_required() and
+          fluid_field()->fs_vel() != nullptr)
+      {
+        scatra_field()->set_fine_scale_velocity(*fluid_to_scatra(fluid_field()->fs_vel()));
+      }
       break;
     }
     case Inpar::FLUID::timeint_one_step_theta:
@@ -316,13 +314,17 @@ void ScaTra::ScaTraAlgorithm::set_velocity_field()
     {
       scatra_field()->set_convective_velocity(*fluid_to_scatra(fluid_field()->velnp()));
       scatra_field()->set_velocity_field(
-          fluid_to_scatra(fluid_field()->hist()), fluid_to_scatra(fluid_field()->velnp()), fsvel);
+          fluid_to_scatra(fluid_field()->hist()), fluid_to_scatra(fluid_field()->velnp()));
+      if (scatra_field()->fine_scale_velocity_field_required() and
+          fluid_field()->fs_vel() != nullptr)
+      {
+        scatra_field()->set_fine_scale_velocity(*fluid_to_scatra(fluid_field()->fs_vel()));
+      }
       break;
     }
     default:
     {
       FOUR_C_THROW("Time integration scheme not supported");
-      break;
     }
   }
 }

src/scatra/4C_scatra_timint_implicit.cpp

@@ -1478,13 +1478,46 @@ void ScaTra::ScaTraTimIntImpl::set_convective_velocity(
   discret_->set_state(nds_vel(), "convective velocity field", convective_velocity);
 }
 
+/*----------------------------------------------------------------------*
+ *----------------------------------------------------------------------*/
+void ScaTra::ScaTraTimIntImpl::set_fine_scale_velocity(
+    const Core::LinAlg::Vector<double>& fine_scale_velocity) const
+{
+  // time measurement
+  TEUCHOS_FUNC_TIME_MONITOR("SCATRA: set fine scale velocity field");
+
+  // checks
+  FOUR_C_ASSERT(velocity_field_type_ == Inpar::ScaTra::velocity_Navier_Stokes,
+      "Wrong set_velocity_field() called for velocity field type {}!", velocity_field_type_);
+  FOUR_C_ASSERT(nds_vel() < discret_->num_dof_sets(), "Too few dof sets on scatra discretization!");
+
+  // provide scatra discretization with fine-scale convective velocity if required
+  discret_->set_state(nds_vel(), "fine-scale velocity field", fine_scale_velocity);
+}
+
+/*----------------------------------------------------------------------*
+ *----------------------------------------------------------------------*/
+bool ScaTra::ScaTraTimIntImpl::fine_scale_velocity_field_required() const
+{
+  // for smagorinsky_all, the fine scale velocity is not necessary
+  if (fssgd_ == Inpar::ScaTra::fssugrdiff_smagorinsky_all) return false;
+
+  // in case the fine-scale subgrid-viscosity is turned off in the scalar field, the fine scale
+  // velocity is not necessary
+  if (turbmodel_ == Inpar::FLUID::no_model and fssgd_ == Inpar::ScaTra::fssugrdiff_no) return false;
+
+  // do not communicate the fine scale velocity field before it was calculated, i.e., in the initial
+  // step
+  if (step_ < 1) return false;
+
+  return true;
+}
 
 /*----------------------------------------------------------------------*
  *----------------------------------------------------------------------*/
 void ScaTra::ScaTraTimIntImpl::set_velocity_field(
     std::shared_ptr<const Core::LinAlg::Vector<double>> acc,
-    std::shared_ptr<const Core::LinAlg::Vector<double>> vel,
-    std::shared_ptr<const Core::LinAlg::Vector<double>> fsvel)
+    std::shared_ptr<const Core::LinAlg::Vector<double>> vel)
 {
   // time measurement
   TEUCHOS_FUNC_TIME_MONITOR("SCATRA: set velocity fields");
@@ -1494,33 +1527,11 @@ void ScaTra::ScaTraTimIntImpl::set_velocity_field(
       "Wrong set_velocity_field() called for velocity field type {}!", velocity_field_type_);
   FOUR_C_ASSERT(nds_vel() < discret_->num_dof_sets(), "Too few dof sets on scatra discretization!");
 
-  // boolean indicating whether fine-scale velocity vector exists
-  // -> if yes, multifractal subgrid-scale modeling is applied
-  bool fsvelswitch = (fsvel != nullptr);
-
-  // some thing went wrong if we want to use multifractal subgrid-scale modeling
-  // and have not got the fine-scale velocity
-  if (step_ >= 1 and
-      (turbmodel_ == Inpar::FLUID::multifractal_subgrid_scales or
-          fssgd_ == Inpar::ScaTra::fssugrdiff_smagorinsky_small) and
-      not fsvelswitch)
-    FOUR_C_THROW("Fine-scale velocity expected for multifractal subgrid-scale modeling!");
-  // as fsvelswitch is also true for smagorinsky_all, we have to reset fsvelswitch
-  // as the corresponding vector, which is not necessary, is not provided in scatra
-  if (fssgd_ == Inpar::ScaTra::fssugrdiff_smagorinsky_all and fsvelswitch) fsvelswitch = false;
-  // as fsvelswitch is true in case of turned-off model in scalar field,
-  // we have to ensure false
-  if (turbmodel_ == Inpar::FLUID::no_model and fssgd_ == Inpar::ScaTra::fssugrdiff_no)
-    fsvelswitch = false;
-
   // provide scatra discretization with velocity
   if (vel != nullptr) discret_->set_state(nds_vel(), "velocity field", *vel);
 
   // provide scatra discretization with acceleration field if required
   if (acc != nullptr) discret_->set_state(nds_vel(), "acceleration field", *acc);
-
-  // provide scatra discretization with fine-scale convective velocity if required
-  if (fsvelswitch) discret_->set_state(nds_vel(), "fine-scale velocity field", *fsvel);
 }
 
 /*----------------------------------------------------------------------*

src/scatra/4C_scatra_timint_implicit.hpp

@@ -247,17 +247,21 @@ namespace ScaTra
     //! set the @convective_velocity vector to the scalar transport discretization
     void set_convective_velocity(const Core::LinAlg::Vector<double>& convective_velocity) const;
 
+    //! set the @fine_scale_velocity vector to the scalar transport discretization
+    void set_fine_scale_velocity(const Core::LinAlg::Vector<double>& fine_scale_velocity) const;
+
+    //! return whether setting of the fine scale velocity is required
+    [[nodiscard]] bool fine_scale_velocity_field_required() const;
+
     /*!
      * @brief set velocity field (+ pressure and acceleration field as well as fine-scale velocity
      * field, if required)
      *
      * @param acc     acceleration vector
      * @param vel     velocity vector
-     * @param fsvel   fine-scale velocity vector
      */
     void set_velocity_field(std::shared_ptr<const Core::LinAlg::Vector<double>> acc,
-        std::shared_ptr<const Core::LinAlg::Vector<double>> vel,
-        std::shared_ptr<const Core::LinAlg::Vector<double>> fsvel);
+        std::shared_ptr<const Core::LinAlg::Vector<double>> vel);
 
     void set_wall_shear_stresses(std::shared_ptr<const Core::LinAlg::Vector<double>> wss);
 

src/ssi/4C_ssi_coupling.cpp

@@ -142,7 +142,7 @@ void SSI::SSICouplingMatchingVolume::set_velocity_fields(
     std::shared_ptr<const Core::LinAlg::Vector<double>> vel)
 {
   scatra->scatra_field()->set_convective_velocity(*convvel);
-  scatra->scatra_field()->set_velocity_field(nullptr, vel, nullptr);
+  scatra->scatra_field()->set_velocity_field(nullptr, vel);
 }
 
 /*----------------------------------------------------------------------*/
@@ -290,7 +290,7 @@ void SSI::SSICouplingNonMatchingBoundary::set_velocity_fields(
   scatra->scatra_field()->set_convective_velocity(
       *adaptermeshtying_->master_to_slave(*extractor_->extract_cond_vector(*convvel)));
   scatra->scatra_field()->set_velocity_field(
-      nullptr, adaptermeshtying_->master_to_slave(*extractor_->extract_cond_vector(*vel)), nullptr);
+      nullptr, adaptermeshtying_->master_to_slave(*extractor_->extract_cond_vector(*vel)));
 }
 
 /*----------------------------------------------------------------------*/
@@ -410,7 +410,7 @@ void SSI::SSICouplingNonMatchingVolume::set_velocity_fields(
   scatra->scatra_field()->set_convective_velocity(
       *volcoupl_structurescatra_->apply_vector_mapping21(*convvel));
   scatra->scatra_field()->set_velocity_field(
-      nullptr, volcoupl_structurescatra_->apply_vector_mapping21(*vel), nullptr);
+      nullptr, volcoupl_structurescatra_->apply_vector_mapping21(*vel));
 }
 
 /*----------------------------------------------------------------------*/
@@ -606,7 +606,7 @@ void SSI::SSICouplingMatchingVolumeAndBoundary::set_velocity_fields(
     std::shared_ptr<const Core::LinAlg::Vector<double>> vel)
 {
   scatra->scatra_field()->set_convective_velocity(*convvel);
-  scatra->scatra_field()->set_velocity_field(nullptr, vel, nullptr);
+  scatra->scatra_field()->set_velocity_field(nullptr, vel);
 }
 
 /*----------------------------------------------------------------------*/

src/ssti/4C_ssti_algorithm.cpp

@@ -290,9 +290,9 @@ void SSTI::SSTIAlgorithm::distribute_structure_solution() const
   const auto convective_velocity = Core::LinAlg::create_vector(*structure_->dof_row_map());
 
   scatra_field()->set_convective_velocity(*convective_velocity);
-  scatra_field()->set_velocity_field(nullptr, structure_->velnp(), nullptr);
+  scatra_field()->set_velocity_field(nullptr, structure_->velnp());
   thermo_field()->set_convective_velocity(*convective_velocity);
-  thermo_field()->set_velocity_field(nullptr, structure_->velnp(), nullptr);
+  thermo_field()->set_velocity_field(nullptr, structure_->velnp());
 }
 
 /*----------------------------------------------------------------------*/