SinglePhaseFVM.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_FLUIDFLOW_SINGLEPHASEFVM_HPP_
#define GEOS_PHYSICSSOLVERS_FLUIDFLOW_SINGLEPHASEFVM_HPP_
 
#include "physicsSolvers/fluidFlow/FlowSolverUtilities.hpp"
#include "physicsSolvers/fluidFlow/SinglePhaseBase.hpp"
#include "physicsSolvers/fluidFlow/SinglePhaseProppantBase.hpp"
 
namespace geos
{
 
 
template< typename BASE = SinglePhaseBase >
class SinglePhaseFVM : public BASE
{
public:
 
  // Aliasing public/protected members/methods of PhysicsSolverBase so we don't
  // have to use this->member etc.
  using BASE::forDiscretizationOnMeshTargets;
  using BASE::m_discretizationName;
  using BASE::m_linearSolverParameters;
  using BASE::m_nonlinearSolverParameters;
  using BASE::m_precond;
 
  // Aliasing public/protected members/methods of FlowSolverBase so we don't
  // have to use this->member etc.
  using BASE::m_numDofPerCell;
  using BASE::m_isThermal;
  using BASE::m_scalingType;
 
  SinglePhaseFVM( const string & name,
                  dataRepository::Group * const parent );
 
 
  SinglePhaseFVM() = delete;
 
  SinglePhaseFVM( SinglePhaseFVM const & ) = delete;
 
  SinglePhaseFVM( SinglePhaseFVM && ) = default;
 
  SinglePhaseFVM & operator=( SinglePhaseFVM const & ) = delete;
 
  SinglePhaseFVM & operator=( SinglePhaseFVM && ) = delete;
 
  virtual ~SinglePhaseFVM() override = default;
 
  static string catalogName()
  {
    if constexpr ( std::is_same_v< BASE, SinglePhaseBase > )
    {
      return "SinglePhaseFVM";
    }
    else if constexpr ( std::is_same_v< BASE, SinglePhaseProppantBase > )
    {
      return "SinglePhaseProppantFVM";
    }
    else
    {
      return BASE::catalogName();
    }
  }
 
  string getCatalogName() const override { return catalogName(); }
 
  virtual void
  setupDofs( DomainPartition const & domain,
             DofManager & dofManager ) const override;
 
  virtual void
  setupSystem( DomainPartition & domain,
               DofManager & dofManager,
               CRSMatrix< real64, globalIndex > & localMatrix,
               ParallelVector & rhs,
               ParallelVector & solution,
               bool const setSparsity = true ) override;
 
  virtual std::unique_ptr< PreconditionerBase< LAInterface > >
  createPreconditioner( DomainPartition & domain ) const override;
 
  virtual void
  applyBoundaryConditions( real64 const time_n,
                           real64 const dt,
                           DomainPartition & domain,
                           DofManager const & dofManager,
                           CRSMatrixView< real64, globalIndex const > const & localMatrix,
                           arrayView1d< real64 > const & localRhs ) override;
 
  virtual real64
  calculateResidualNorm( real64 const & time_n,
                         real64 const & dt,
                         DomainPartition const & domain,
                         DofManager const & dofManager,
                         arrayView1d< real64 const > const & localRhs ) override;
 
  virtual void
  applySystemSolution( DofManager const & dofManager,
                       arrayView1d< real64 const > const & localSolution,
                       real64 const scalingFactor,
                       real64 const dt,
                       DomainPartition & domain ) override;
  virtual void
  assembleFluxTerms( real64 const dt,
                     DomainPartition const & domain,
                     DofManager const & dofManager,
                     CRSMatrixView< real64, globalIndex const > const & localMatrix,
                     arrayView1d< real64 > const & localRhs ) override;
 
  virtual void
  assembleStabilizedFluxTerms( real64 const dt,
                               DomainPartition const & domain,
                               DofManager const & dofManager,
                               CRSMatrixView< real64, globalIndex const > const & localMatrix,
                               arrayView1d< real64 > const & localRhs ) override;
  virtual void
  assembleEDFMFluxTerms( real64 const time_n,
                         real64 const dt,
                         DomainPartition const & domain,
                         DofManager const & dofManager,
                         CRSMatrixView< real64, globalIndex const > const & localMatrix,
                         arrayView1d< real64 > const & localRhs,
                         string const & jumpDofKey ) override final;
 
  virtual void
  assembleHydrofracFluxTerms( real64 const time_n,
                              real64 const dt,
                              DomainPartition const & domain,
                              DofManager const & dofManager,
                              CRSMatrixView< real64, globalIndex const > const & localMatrix,
                              arrayView1d< real64 > const & localRhs,
                              CRSMatrixView< real64, localIndex const > const & dR_dAper,
                              stdMap< string, localIndex > const * const dR_dAperOffsets ) override final;
 
  virtual void
  applyAquiferBC( real64 const time,
                  real64 const dt,
                  DomainPartition & domain,
                  DofManager const & dofManager,
                  CRSMatrixView< real64, globalIndex const > const & localMatrix,
                  arrayView1d< real64 > const & localRhs ) const override;
 
  virtual void initializePreSubGroups() override;
 
  struct viewKeyStruct : BASE::viewKeyStruct
  {
    // nonlinear solver parameters
    static constexpr char const * scalingTypeString() { return "scalingType"; }
  };
 
private:
 
  void applyFaceDirichletBC( real64 const time_n,
                             real64 const dt,
                             DofManager const & faceSet,
                             DomainPartition & domain,
                             CRSMatrixView< real64, globalIndex const > const & localMatrix,
                             arrayView1d< real64 > const & localRhs );
 
};
 
} /* namespace geos */
 
#endif //GEOS_PHYSICSSOLVERS_FLUIDFLOW_SINGLEPHASEFVM_HPP_