FlowProppantTransportSolver.hpp

Go to the documentation of this file.

/*
 * ------------------------------------------------------------------------------------------------------------
 * SPDX-License-Identifier: LGPL-2.1-only
 *
 * Copyright (c) 2016-2024 Lawrence Livermore National Security LLC
 * Copyright (c) 2018-2024 TotalEnergies
 * Copyright (c) 2018-2024 The Board of Trustees of the Leland Stanford Junior University
 * Copyright (c) 2023-2024 Chevron
 * Copyright (c) 2019-     GEOS/GEOSX Contributors
 * All rights reserved
 *
 * See top level LICENSE, COPYRIGHT, CONTRIBUTORS, NOTICE, and ACKNOWLEDGEMENTS files for details.
 * ------------------------------------------------------------------------------------------------------------
 */
 
#ifndef GEOS_PHYSICSSOLVERS_MULTIPHYSICS_FLOWPROPPANTTRANSPORTSOLVER_HPP_
#define GEOS_PHYSICSSOLVERS_MULTIPHYSICS_FLOWPROPPANTTRANSPORTSOLVER_HPP_
 
#include "physicsSolvers/multiphysics/CoupledSolver.hpp"
 
namespace geos
{
 
class ProppantTransport;
class FlowSolverBase;
 
class FlowProppantTransportSolver : public CoupledSolver< ProppantTransport,
                                                          FlowSolverBase >
{
public:
 
  using Base = CoupledSolver< ProppantTransport, FlowSolverBase >;
  using Base::m_solvers;
  using Base::m_dofManager;
  using Base::m_localMatrix;
  using Base::m_rhs;
  using Base::m_solution;
 
  enum class SolverType : integer
  {
    ProppantTransport = 0,
    Flow = 1
  };
 
  FlowProppantTransportSolver( const string & name,
                               Group * const parent );
 
  ~FlowProppantTransportSolver() override {};
 
  static string catalogName() { return "FlowProppantTransport"; }
  string getCatalogName() const override { return catalogName(); }
 
  ProppantTransport * proppantTransportSolver() const
  {
    return std::get< toUnderlying( SolverType::ProppantTransport ) >( m_solvers );
  }
 
  FlowSolverBase * flowSolver() const
  {
    return std::get< toUnderlying( SolverType::Flow ) >( m_solvers );
  }
 
private:
 
  real64 sequentiallyCoupledSolverStep( real64 const & time_n,
                                        real64 const & dt,
                                        int const cycleNumber,
                                        DomainPartition & domain ) override final;
 
  void preStepUpdate( real64 const & time_n,
                      real64 const & dt,
                      DomainPartition & domain );
 
  void postStepUpdate( real64 const & time_n,
                       real64 const & dt,
                       DomainPartition & domain );
 
};
 
} /* namespace geos */
 
#endif /* GEOS_PHYSICSSOLVERS_MULTIPHYSICS_FLOWPROPPANTTRANSPORTSOLVER_HPP_ */