SinglePhaseBase.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_SINGLEPHASEBASE_HPP_
#define GEOS_PHYSICSSOLVERS_FLUIDFLOW_SINGLEPHASEBASE_HPP_
 
#include "physicsSolvers/fluidFlow/FlowSolverBase.hpp"
#include "physicsSolvers/fluidFlow/kernels/singlePhase/AccumulationKernels.hpp"
#include "physicsSolvers/fluidFlow/kernels/singlePhase/ThermalAccumulationKernels.hpp"
#include "constitutive/fluid/singlefluid/SingleFluidBase.hpp"
#include "constitutive/solid/CoupledSolidBase.hpp"
#include "constitutive/fluid/singlefluid/SingleFluidLayouts.hpp"
#include "constitutive/fluid/singlefluid/SingleFluidUtils.hpp"
 
 
namespace geos
{
 
namespace constitutive
{
 
class ConstitutiveBase;
 
}
 
class SinglePhaseBase : public FlowSolverBase
{
public:
  using SingleFluidProp = constitutive::SingleFluidVar< real64, 2, constitutive::singlefluid::LAYOUT_FLUID, constitutive::singlefluid::LAYOUT_FLUID_DER >;
 
  SinglePhaseBase( const string & name,
                   Group * const parent );
 
 
  SinglePhaseBase() = delete;
 
  SinglePhaseBase( SinglePhaseBase const & ) = delete;
 
  SinglePhaseBase( SinglePhaseBase && ) = default;
 
  SinglePhaseBase & operator=( SinglePhaseBase const & ) = delete;
 
  SinglePhaseBase & operator=( SinglePhaseBase && ) = delete;
 
  virtual ~SinglePhaseBase() override = default;
 
  virtual void registerDataOnMesh( Group & meshBodies ) override;
 
 
  virtual void
  implicitStepSetup( real64 const & time_n,
                     real64 const & dt,
                     DomainPartition & domain ) override;
 
  virtual void
  assembleSystem( real64 const time_n,
                  real64 const dt,
                  DomainPartition & domain,
                  DofManager const & dofManager,
                  CRSMatrixView< real64, globalIndex const > const & localMatrix,
                  arrayView1d< real64 > const & localRhs ) 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
  scalingForSystemSolution( DomainPartition & domain,
                            DofManager const & dofManager,
                            arrayView1d< real64 const > const & localSolution ) override;
 
  virtual bool
  checkSystemSolution( DomainPartition & domain,
                       DofManager const & dofManager,
                       arrayView1d< real64 const > const & localSolution,
                       real64 const scalingFactor ) override;
 
  virtual void
  resetStateToBeginningOfStep( DomainPartition & domain ) override;
 
  virtual void
  implicitStepComplete( real64 const & time,
                        real64 const & dt,
                        DomainPartition & domain ) override;
 
 
  void assembleAccumulationTerms( DomainPartition & domain,
                                  DofManager const & dofManager,
                                  CRSMatrixView< real64, globalIndex const > const & localMatrix,
                                  arrayView1d< real64 > const & localRhs );
 
  template< typename SUBREGION_TYPE >
  void accumulationAssemblyLaunch( DofManager const & dofManager,
                                   SUBREGION_TYPE const & subRegion,
                                   CRSMatrixView< real64, globalIndex const > const & localMatrix,
                                   arrayView1d< real64 > const & localRhs );
 
  virtual void
  assembleFluxTerms( real64 const dt,
                     DomainPartition const & domain,
                     DofManager const & dofManager,
                     CRSMatrixView< real64, globalIndex const > const & localMatrix,
                     arrayView1d< real64 > const & localRhs ) = 0;
 
  virtual void
  assembleStabilizedFluxTerms( real64 const dt,
                               DomainPartition const & domain,
                               DofManager const & dofManager,
                               CRSMatrixView< real64, globalIndex const > const & localMatrix,
                               arrayView1d< real64 > const & localRhs ) = 0;
 
  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 ) = 0;
 
  struct viewKeyStruct : FlowSolverBase::viewKeyStruct
  {
    static constexpr char const * elemDofFieldString() { return "singlePhaseVariables"; }
  };
 
  void
  applyDirichletBC( real64 const time_n,
                    real64 const dt,
                    DomainPartition & domain,
                    DofManager const & dofManager,
                    CRSMatrixView< real64, globalIndex const > const & localMatrix,
                    arrayView1d< real64 > const & localRhs ) const;
 
  void
  applySourceFluxBC( real64 const time_n,
                     real64 const dt,
                     DomainPartition & domain,
                     DofManager const & dofManager,
                     CRSMatrixView< real64, globalIndex const > const & localMatrix,
                     arrayView1d< real64 > const & localRhs ) const;
 
  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 = 0;
 
  virtual void
  updateState ( DomainPartition & domain ) override final;
 
  real64
  updateFluidState( ElementSubRegionBase & subRegion ) const;
 
 
  virtual void
  updateFluidModel( ObjectManagerBase & dataGroup ) const;
 
  void
  updateMass( ElementSubRegionBase & subRegion ) const;
 
  void
  updateEnergy( ElementSubRegionBase & subRegion ) const;
 
  void updateSolidInternalEnergyModel( ObjectManagerBase & dataGroup ) const;
 
  void updateThermalConductivity( ElementSubRegionBase & subRegion ) const;
 
  void
  updateMobility( ObjectManagerBase & dataGroup ) const;
 
  virtual void initializePreSubGroups() override;
 
  virtual void initializePostInitialConditionsPreSubGroups() override;
 
  virtual void initializeFluidState( MeshLevel & mesh, string_array const & regionNames ) override;
 
  virtual void initializeThermalState( MeshLevel & mesh, string_array const & regionNames ) override;
 
  virtual void computeHydrostaticEquilibrium( DomainPartition & domain ) override;
 
  virtual void updatePressureGradient( DomainPartition & domain )
  {
    GEOS_UNUSED_VAR( domain );
  }
 
  void keepVariablesConstantDuringInitStep( real64 const time,
                                            real64 const dt,
                                            DofManager const & dofManager,
                                            DomainPartition & domain,
                                            CRSMatrixView< real64, globalIndex const > const & localMatrix,
                                            arrayView1d< real64 > const & localRhs ) const;
 
protected:
 
  virtual void validateConstitutiveModels( DomainPartition & domain ) const;
 
  void initializeAquiferBC() const;
 
  virtual void setConstitutiveNamesCallSuper( ElementSubRegionBase & subRegion ) const override;
 
  virtual void saveConvergedState( ElementSubRegionBase & subRegion ) const override;
 
  struct FluidPropViews
  {
    arrayView2d< real64 const, constitutive::singlefluid::USD_FLUID > const dens;             
    arrayView3d< real64 const, constitutive::singlefluid::USD_FLUID_DER > const dDens;             
    arrayView2d< real64 const, constitutive::singlefluid::USD_FLUID > const visc;             
    arrayView3d< real64 const, constitutive::singlefluid::USD_FLUID_DER > const dVisc;             
    real64 const defaultDensity;                     
    real64 const defaultViscosity;                    
  };
 
 
  virtual FluidPropViews getFluidProperties( constitutive::ConstitutiveBase const & fluid ) const;
 
 
private:
  virtual void setConstitutiveNames( ElementSubRegionBase & subRegion ) const override;
 
};
 
template< typename SUBREGION_TYPE >
void SinglePhaseBase::accumulationAssemblyLaunch( DofManager const & dofManager,
                                                  SUBREGION_TYPE const & subRegion,
                                                  CRSMatrixView< real64, globalIndex const > const & localMatrix,
                                                  arrayView1d< real64 > const & localRhs )
{
  geos::constitutive::SingleFluidBase const & fluid =
    getConstitutiveModel< geos::constitutive::SingleFluidBase >( subRegion, subRegion.template getReference< string >( viewKeyStruct::fluidNamesString() ) );
  //START_SPHINX_INCLUDE_COUPLEDSOLID
  geos::constitutive::CoupledSolidBase const & solid =
    getConstitutiveModel< geos::constitutive::CoupledSolidBase >( subRegion, subRegion.template getReference< string >( viewKeyStruct::solidNamesString() ) );
  //END_SPHINX_INCLUDE_COUPLEDSOLID
 
  string const dofKey = dofManager.getKey( viewKeyStruct::elemDofFieldString() );
 
  if( m_isThermal )
  {
    thermalSinglePhaseBaseKernels::
      AccumulationKernelFactory::
      createAndLaunch< parallelDevicePolicy<> >( dofManager.rankOffset(),
                                                 dofKey,
                                                 subRegion,
                                                 fluid,
                                                 solid,
                                                 localMatrix,
                                                 localRhs );
  }
  else
  {
    singlePhaseBaseKernels::
      AccumulationKernelFactory::
      createAndLaunch< parallelDevicePolicy<> >( dofManager.rankOffset(),
                                                 dofKey,
                                                 subRegion,
                                                 fluid,
                                                 solid,
                                                 localMatrix,
                                                 localRhs );
  }
}
 
} /* namespace geos */
 
#endif //GEOS_PHYSICSSOLVERS_FLUIDFLOW_SINGLEPHASEBASE_HPP_