ProppantTransport.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_PROPPANTTRANSPORT_PROPPANTTRANSPORT_HPP_
#define GEOS_PHYSICSSOLVERS_FLUIDFLOW_PROPPANTTRANSPORT_PROPPANTTRANSPORT_HPP_
 
#include "physicsSolvers/fluidFlow/FlowSolverBase.hpp"
#include "constitutive/fluid/singlefluid/ParticleFluidBase.hpp"
#include "constitutive/fluid/singlefluid/SlurryFluidBase.hpp"
 
namespace geos
{
 
namespace dataRepository
{
class Group;
}
class FieldSpecificationBase;
class FiniteElementBase;
class DomainPartition;
 
class ProppantTransport : public FlowSolverBase
{
public:
 
  static string coupledSolverAttributePrefix() { return "proppant"; }
 
  ProppantTransport( const string & name,
                     Group * const parent );
 
 
  ProppantTransport() = delete;
 
  ProppantTransport( ProppantTransport const & ) = delete;
 
  ProppantTransport( ProppantTransport && ) = default;
 
  ProppantTransport & operator=( ProppantTransport const & ) = delete;
 
  ProppantTransport & operator=( ProppantTransport && ) = delete;
 
  virtual ~ProppantTransport() override = default;
 
  static string catalogName() { return "ProppantTransport"; }
  string getCatalogName() const override { return catalogName(); }
 
  virtual void initializePreSubGroups() override;
 
  virtual void registerDataOnMesh( Group & meshBodies ) override;
 
  void preStepUpdate( real64 const & time_n,
                      real64 const & dt,
                      DomainPartition & domain );
 
  void postStepUpdate( real64 const & time_n,
                       real64 const & dt,
                       DomainPartition & domain );
 
  virtual void
  implicitStepSetup( real64 const & time_n,
                     real64 const & dt,
                     DomainPartition & domain ) override;
 
  virtual void
  setupDofs( DomainPartition const & domain,
             DofManager & dofManager ) const override;
 
  virtual void
  assembleSystem( real64 const time,
                  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,
                           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
  resetStateToBeginningOfStep( DomainPartition & domain ) override;
 
  virtual void
  implicitStepComplete( real64 const & time,
                        real64 const & dt,
                        DomainPartition & domain ) override;
 
  void assembleAccumulationTerms( real64 const dt,
                                  DomainPartition const & domain,
                                  DofManager const & dofManager,
                                  CRSMatrixView< real64, globalIndex const > const & localMatrix,
                                  arrayView1d< real64 > const & localRhs );
 
  void assembleFluxTerms( real64 const dt,
                          DomainPartition const & domain,
                          DofManager const & dofManager,
                          CRSMatrixView< real64, globalIndex const > const & localMatrix,
                          arrayView1d< real64 > const & localRhs );
 
  void resizeFractureFields( MeshLevel & mesh, arrayView1d< string const > const & regionNames );
 
  struct viewKeyStruct : FlowSolverBase::viewKeyStruct
  {
    static constexpr char const * proppantNamesString() { return "proppantNames"; }
 
    // these are used to store last converged time step values
 
    static constexpr char const * updateProppantPackingString() { return "updateProppantPacking"; }
    static constexpr char const * bridgingFactorString() { return "bridgingFactor"; }
    static constexpr char const * maxProppantConcentrationString() { return "maxProppantConcentration"; }
    static constexpr char const * proppantDiameterString() { return "proppantDiameter"; }
    static constexpr char const * proppantDensityString() { return "proppantDensity"; }
    static constexpr char const * criticalShieldsNumberString() { return "criticalShieldsNumber"; }
    static constexpr char const * frictionCoefficientString() { return "frictionCoefficient"; }
  };
 
  virtual void initializePostInitialConditionsPreSubGroups() override;
 
  void updateProppantMobility( ObjectManagerBase & dataGroup );
 
  void updateProppantPackVolume( real64 const time_n, real64 const dt, DomainPartition & domain );
 
  virtual void updateState ( DomainPartition & domain ) override final { GEOS_UNUSED_VAR( domain ); };
 
  void updateState( ObjectManagerBase & dataGroup );
 
protected:
 
  virtual void postInputInitialization() override;
 
private:
 
  void updateFluidModel( ObjectManagerBase & dataGroup );
 
  void updateComponentDensity( ObjectManagerBase & dataGroup );
 
  void updateProppantModel( ObjectManagerBase & dataGroup );
 
  void updateCellBasedFlux( real64 const time_n,
                            DomainPartition & domain );
 
  void setConstitutiveNames( ElementSubRegionBase & subRegion ) const override;
 
  integer m_numComponents;
 
  integer m_updateProppantPacking;
  real64 m_bridgingFactor;
  real64 m_minAperture;
  real64 m_maxProppantConcentration;
  real64 m_proppantDiameter;
  real64 m_proppantDensity;
  real64 m_criticalShieldsNumber;
  real64 m_frictionCoefficient;
};
 
 
} /* namespace geos */
 
#endif //GEOS_PHYSICSSOLVERS_FLUIDFLOW_PROPPANTTRANSPORT_PROPPANTTRANSPORT_HPP_