Merge pull request #730 from c-p-schmidt/clean-scatra-set-state-methods

Clean scatra set state methods

Author: c-p-schmidt

src/adapter/4C_adapter_scatra_fluid_coupling_algorithm.cpp

@@ -84,11 +84,14 @@ void Adapter::ScaTraFluidCouplingAlgorithm::setup()
   // transfer the initial convective velocity from initial fluid field to scalar transport field
   // subgrid scales not transferred since they are zero at time t=0.0
   if (!volcoupl_fluidscatra_)
-    scatra_field()->set_velocity_field(fluid_field()->convective_vel(), nullptr, nullptr, nullptr);
+  {
+    scatra_field()->set_convective_velocity(*fluid_field()->convective_vel());
+  }
   else
-    scatra_field()->set_velocity_field(
-        volcoupl_fluidscatra_->apply_vector_mapping21(*fluid_field()->convective_vel()), nullptr,
-        nullptr, nullptr);
+  {
+    scatra_field()->set_convective_velocity(
+        *volcoupl_fluidscatra_->apply_vector_mapping21(*fluid_field()->convective_vel()));
+  }
 
   // ensure that both single field solvers use the same
   // time integration scheme

src/elch/4C_elch_dyn.cpp

@@ -108,10 +108,10 @@ void elch_dyn(int restart)
       if (restart) scatraonly.scatra_field()->read_restart(restart);
 
       // set velocity field
-      // note: The order read_restart() before set_velocity_field() is important here!!
-      // for time-dependent velocity fields, set_velocity_field() is additionally called in each
-      // prepare_time_step()-call
-      scatraonly.scatra_field()->set_velocity_field();
+      // note: The order read_restart() before set_velocity_field_from_function() is important
+      // here!! for time-dependent velocity fields, set_velocity_field_from_function() is
+      // additionally called in each prepare_time_step()-call
+      scatraonly.scatra_field()->set_velocity_field_from_function();
 
       // enter time loop to solve problem with given convective velocity
       scatraonly.scatra_field()->time_loop();

src/elch/4C_elch_moving_boundary_algorithm.cpp

@@ -81,7 +81,7 @@ void ElCh::MovingBoundaryAlgorithm::setup()
   }
 
   // transfer moving mesh data
-  scatra_field()->apply_mesh_movement(ale_field()->dispnp());
+  scatra_field()->apply_mesh_movement(*ale_field()->dispnp());
 
   // initialize the multivector for all possible cases
   fluxn_ = scatra_field()->calc_flux_at_boundary(false);
@@ -111,12 +111,13 @@ void ElCh::MovingBoundaryAlgorithm::time_loop()
   if (not pseudotransient_)
   {
     // transfer convective velocity = fluid velocity - grid velocity
-    scatra_field()->set_velocity_field(fluid_field()->convective_vel(),  // = velnp - grid velocity
-        fluid_field()->hist(), nullptr, nullptr);
+    scatra_field()->set_convective_velocity(*fluid_field()->convective_vel());
+    scatra_field()->set_velocity_field(*fluid_field()->convective_vel());
+    scatra_field()->set_acceleration_field(*fluid_field()->hist());
   }
 
   // transfer moving mesh data
-  scatra_field()->apply_mesh_movement(ale_field()->dispnp());
+  scatra_field()->apply_mesh_movement(*ale_field()->dispnp());
 
   // time loop
   while (not_finished())
@@ -248,37 +249,35 @@ void ElCh::MovingBoundaryAlgorithm::solve_scatra()
 {
   if (Core::Communication::my_mpi_rank(get_comm()) == 0)
   {
-    std::cout << std::endl;
-    std::cout << "************************" << std::endl;
-    std::cout << "       ELCH SOLVER      " << std::endl;
-    std::cout << "************************" << std::endl;
+    std::cout << '\n';
+    std::cout << "************************" << '\n';
+    std::cout << "       ELCH SOLVER      " << '\n';
+    std::cout << "************************" << '\n';
   }
 
   switch (fluid_field()->tim_int_scheme())
   {
     case Inpar::FLUID::timeint_npgenalpha:
     case Inpar::FLUID::timeint_afgenalpha:
       FOUR_C_THROW("ConvectiveVel() not implemented for Gen.Alpha versions");
-      break;
     case Inpar::FLUID::timeint_one_step_theta:
     case Inpar::FLUID::timeint_bdf2:
     {
       if (not pseudotransient_)
       {
         // transfer convective velocity = fluid velocity - grid velocity
-        scatra_field()->set_velocity_field(
-            fluid_field()->convective_vel(),  // = velnp - grid velocity
-            fluid_field()->hist(), nullptr, nullptr);
+        scatra_field()->set_convective_velocity(*fluid_field()->convective_vel());
+        scatra_field()->set_velocity_field(*fluid_field()->convective_vel());
+        scatra_field()->set_acceleration_field(*fluid_field()->hist());
       }
     }
     break;
     default:
       FOUR_C_THROW("Time integration scheme not supported");
-      break;
   }
 
   // transfer moving mesh data
-  scatra_field()->apply_mesh_movement(ale_field()->dispnp());
+  scatra_field()->apply_mesh_movement(*ale_field()->dispnp());
 
   // solve coupled electrochemistry equations
   scatra_field()->solve();

src/fs3i/4C_fs3i_fps3i_partitioned.cpp

@@ -615,11 +615,11 @@ void FS3I::PartFPS3I::set_struct_scatra_solution()
 void FS3I::PartFPS3I::set_mesh_disp()
 {
   // fluid field
-  scatravec_[0]->scatra_field()->apply_mesh_movement(fpsi_->fluid_field()->dispnp());
+  scatravec_[0]->scatra_field()->apply_mesh_movement(*fpsi_->fluid_field()->dispnp());
 
   // Poro field
   scatravec_[1]->scatra_field()->apply_mesh_movement(
-      fpsi_->poro_field()->structure_field()->dispnp());
+      *fpsi_->poro_field()->structure_field()->dispnp());
 }
 
 
@@ -637,10 +637,9 @@ void FS3I::PartFPS3I::set_velocity_fields()
     case Inpar::ScaTra::velocity_zero:
     case Inpar::ScaTra::velocity_function:
     {
-      for (unsigned i = 0; i < scatravec_.size(); ++i)
+      for (auto scatra : scatravec_)
       {
-        std::shared_ptr<Adapter::ScaTraBaseAlgorithm> scatra = scatravec_[i];
-        scatra->scatra_field()->set_velocity_field();
+        scatra->scatra_field()->set_velocity_field_from_function();
       }
       break;
     }
@@ -652,8 +651,8 @@ void FS3I::PartFPS3I::set_velocity_fields()
 
       for (unsigned i = 0; i < scatravec_.size(); ++i)
       {
-        std::shared_ptr<Adapter::ScaTraBaseAlgorithm> scatra = scatravec_[i];
-        scatra->scatra_field()->set_velocity_field(convel[i], nullptr, vel[i], nullptr);
+        scatravec_[i]->scatra_field()->set_convective_velocity(*convel[i]);
+        scatravec_[i]->scatra_field()->set_velocity_field(*vel[i]);
       }
       break;
     }
@@ -671,7 +670,7 @@ void FS3I::PartFPS3I::set_wall_shear_stresses()
   for (unsigned i = 0; i < scatravec_.size(); ++i)
   {
     std::shared_ptr<Adapter::ScaTraBaseAlgorithm> scatra = scatravec_[i];
-    scatra->scatra_field()->set_wall_shear_stresses(wss[i]);
+    scatra->scatra_field()->set_wall_shear_stresses(*wss[i]);
   }
 }
 
@@ -686,7 +685,7 @@ void FS3I::PartFPS3I::set_pressure_fields()
   for (unsigned i = 0; i < scatravec_.size(); ++i)
   {
     std::shared_ptr<Adapter::ScaTraBaseAlgorithm> scatra = scatravec_[i];
-    scatra->scatra_field()->set_pressure_field(pressure[i]);
+    scatra->scatra_field()->set_pressure_field(*pressure[i]);
   }
 }
 

src/fs3i/4C_fs3i_partitioned.cpp

@@ -683,12 +683,12 @@ void FS3I::PartFS3I::set_mesh_disp() const
   // fluid field
   std::shared_ptr<Adapter::ScaTraBaseAlgorithm> fluidscatra = scatravec_[0];
   fluidscatra->scatra_field()->apply_mesh_movement(
-      fluid_to_fluid_scalar(fsi_->fluid_field()->dispnp()));
+      *fluid_to_fluid_scalar(fsi_->fluid_field()->dispnp()));
 
   // structure field
   std::shared_ptr<Adapter::ScaTraBaseAlgorithm> structscatra = scatravec_[1];
   structscatra->scatra_field()->apply_mesh_movement(
-      structure_to_structure_scalar(fsi_->structure_field()->dispnp()));
+      *structure_to_structure_scalar(fsi_->structure_field()->dispnp()));
 }
 
 
@@ -702,9 +702,9 @@ void FS3I::PartFS3I::set_velocity_fields() const
 
   for (unsigned i = 0; i < scatravec_.size(); ++i)
   {
-    std::shared_ptr<Adapter::ScaTraBaseAlgorithm> scatra = scatravec_[i];
-    scatra->scatra_field()->set_velocity_field(vol_mortar_master_to_slavei(i, convel[i]), nullptr,
-        vol_mortar_master_to_slavei(i, vel[i]), nullptr);
+    scatravec_[i]->scatra_field()->set_convective_velocity(
+        *vol_mortar_master_to_slavei(i, convel[i]));
+    scatravec_[i]->scatra_field()->set_velocity_field(*vol_mortar_master_to_slavei(i, vel[i]));
   }
 }
 
@@ -762,7 +762,7 @@ void FS3I::PartFS3I::set_wall_shear_stresses() const
   for (unsigned i = 0; i < scatravec_.size(); ++i)
   {
     std::shared_ptr<Adapter::ScaTraBaseAlgorithm> scatra = scatravec_[i];
-    scatra->scatra_field()->set_wall_shear_stresses(vol_mortar_master_to_slavei(i, wss[i]));
+    scatra->scatra_field()->set_wall_shear_stresses(*vol_mortar_master_to_slavei(i, wss[i]));
   }
 }
 

src/fs3i/4C_fs3i_partitioned_2wc.cpp

@@ -103,8 +103,7 @@ void FS3I::PartFS3I2Wc::initial_calculations()
 {
   // set initial fluid velocity field for evaluation of initial scalar
   // time derivative in fluid-based scalar transport
-  scatravec_[0]->scatra_field()->set_velocity_field(
-      fsi_->fluid_field()->velnp(), nullptr, nullptr, nullptr);
+  scatravec_[0]->scatra_field()->set_convective_velocity(*fsi_->fluid_field()->velnp());
 
   // set initial value of thermodynamic pressure in fluid-based scalar
   // transport

src/levelset/4C_levelset_algorithm.hpp

@@ -66,15 +66,6 @@ namespace ScaTra
     //! set the velocity field (zero or field by function) (pure level-set problems)
     void set_velocity_field(bool init = false);
 
-    /// set convective velocity field (+ pressure and acceleration field as
-    /// well as fine-scale velocity field, if required) (function for coupled fluid problems)
-    void set_velocity_field(std::shared_ptr<const Core::LinAlg::Vector<double>> convvel,
-        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, bool setpressure = false,
-        bool init = false);
-
-
     // output position of center of mass assuming a smoothed interfaces
     void mass_center_using_smoothing();
 

src/levelset/4C_levelset_algorithm_utils.cpp

@@ -29,7 +29,7 @@ FOUR_C_NAMESPACE_OPEN
 void ScaTra::LevelSetAlgorithm::set_velocity_field(bool init)
 {
   // call function of base class
-  ScaTraTimIntImpl::set_velocity_field();
+  ScaTraTimIntImpl::set_velocity_field_from_function();
 
   // note: This function is only called from the level-set dyn. This is ok, since
   //       we only want to initialize conveln_ at the beginning of the simulation.
@@ -38,29 +38,6 @@ void ScaTra::LevelSetAlgorithm::set_velocity_field(bool init)
 }
 
 
-/*----------------------------------------------------------------------*
- | set convective velocity field (+ pressure and acceleration field as  |
- | well as fine-scale velocity field, if required)      rasthofer 11/13 |
- *----------------------------------------------------------------------*/
-void ScaTra::LevelSetAlgorithm::set_velocity_field(
-    std::shared_ptr<const Core::LinAlg::Vector<double>> convvel,
-    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, bool setpressure, bool init)
-{
-  // call routine of base class
-  ScaTraTimIntImpl::set_velocity_field(convvel, acc, vel, fsvel, setpressure);
-
-  // manipulate velocity field away from the interface
-  if (extract_interface_vel_) manipulate_fluid_field_for_gfunc();
-
-  // estimate velocity at contact points, i.e., intersection points of interface and (no-slip) walls
-  if (cpbc_) apply_contact_point_boundary_condition();
-
-  return;
-}
-
-
 /*----------------------------------------------------------------------*
  | add problem depended params for assemble_mat_and_rhs    rasthofer 09/13 |
  *----------------------------------------------------------------------*/

src/loma/4C_loma_algorithm.cpp

@@ -311,10 +311,13 @@ void LowMach::Algorithm::time_loop()
 /*----------------------------------------------------------------------*/
 void LowMach::Algorithm::initial_calculations()
 {
-  // set initial velocity field for evaluation of initial scalar time
-  // derivative in SCATRA
-  scatra_field()->set_velocity_field(
-      fluid_field()->velnp(), nullptr, nullptr, fluid_field()->fs_vel());
+  // 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(*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();
@@ -328,11 +331,6 @@ void LowMach::Algorithm::initial_calculations()
   fluid_field()->set_scalar_fields(scatra_field()->phinp(),
       std::dynamic_pointer_cast<ScaTra::ScaTraTimIntLoma>(scatra_field())->therm_press_np(),
       nullptr, scatra_field()->discretization());
-
-  // write initial fields
-  // output();
-
-  return;
 }
 
 
@@ -532,8 +530,6 @@ void LowMach::Algorithm::mono_loop()
     // check convergence and stop iteration loop if convergence is achieved
     stopnonliniter = convergence_check(itnum);
   }
-
-  return;
 }
 
 
@@ -547,22 +543,32 @@ void LowMach::Algorithm::set_fluid_values_in_scatra()
   {
     case Inpar::FLUID::timeint_afgenalpha:
     {
-      scatra_field()->set_velocity_field(
-          fluid_field()->velaf(), fluid_field()->accam(), nullptr, fluid_field()->fs_vel(), true);
+      scatra_field()->set_acceleration_field(*fluid_field()->accam());
+      scatra_field()->set_convective_velocity(*fluid_field()->velaf());
+      scatra_field()->set_velocity_field(*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_velocity_field(
-          fluid_field()->velnp(), fluid_field()->hist(), nullptr, fluid_field()->fs_vel(), true);
+      scatra_field()->set_acceleration_field(*fluid_field()->hist());
+      scatra_field()->set_convective_velocity(*fluid_field()->velnp());
+      scatra_field()->set_velocity_field(*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:
       FOUR_C_THROW("Time integration scheme not supported");
-      break;
   }
-  return;
 }
 
 

src/loma/4C_loma_dyn.cpp

@@ -104,10 +104,10 @@ void loma_dyn(int restart)
       if (restart) (scatraonly.scatra_field())->read_restart(restart);
 
       // set initial velocity field
-      // note: The order read_restart() before set_velocity_field() is important here!!
-      // for time-dependent velocity fields, set_velocity_field() is additionally called in each
-      // prepare_time_step()-call
-      (scatraonly.scatra_field())->set_velocity_field();
+      // note: The order read_restart() before set_velocity_field_from_function() is important
+      // here!! for time-dependent velocity fields, set_velocity_field_from_function() is
+      // additionally called in each prepare_time_step()-call
+      (scatraonly.scatra_field())->set_velocity_field_from_function();
 
       // enter time loop to solve problem with given convective velocity field
       (scatraonly.scatra_field())->time_loop();