FieldApplicator.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 SRC_CORECOMPONENTS_PHYSICSSOLVERS_FIELDAPPLICATOR_HPP_
#define SRC_CORECOMPONENTS_PHYSICSSOLVERS_FIELDAPPLICATOR_HPP_
 
#include "events/tasks/TaskBase.hpp"
 
namespace geos
{
 
class EquilibriumInitialCondition;
class FunctionManager;
class FlowSolverBase;
class CompositionalMultiphaseBase;
class ElementSubRegionBase;
 
 
class FieldApplicator : public TaskBase
{
public:
 
  FieldApplicator( const string & name,
                   Group * const parent );
 
  ~FieldApplicator() override;
 
  static string catalogName()
  {
    return "FieldApplicator";
  }
 
  virtual bool execute( real64 const time_n,
                        real64 const dt,
                        integer const cycleNumber,
                        integer const eventCounter,
                        real64 const eventProgress,
                        DomainPartition & domain ) override;
 
private:
 
  struct viewKeyStruct
  {
    constexpr static char const * fieldSpecificationNamesString() { return "fieldSpecificationNames"; }
    constexpr static char const * solverNameString() { return "solverName"; }
    constexpr static char const * targetRegionsString() { return "targetRegions"; }
  };
 
  void postInputInitialization() override;
 
  string getTargetFieldName( string const & fieldName ) const;
 
 
  void initializeSubRegionFluidState( DomainPartition & domain, ElementSubRegionBase & subRegion );
 
  stdVector< string > m_fieldSpecificationNames;
 
  string m_solverName;
 
  stdVector< string > m_targetRegions;
};
 
 
} /* namespace geos */
 
#endif /* SRC_CORECOMPONENTS_PHYSICSSOLVERS_FIELDAPPLICATOR_HPP_ */