MultivariableTableFunction.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_FUNCTIONS_MULTIVARIABLETABLEFUNCTION_HPP_
#define GEOS_FUNCTIONS_MULTIVARIABLETABLEFUNCTION_HPP_
 
#include "FunctionBase.hpp"
 
#include "common/format/EnumStrings.hpp"
#include "LvArray/src/tensorOps.hpp"
 
namespace geos
{
 
class MultivariableTableFunction : public FunctionBase
{
public:
 
  MultivariableTableFunction( const string & name,
                              Group * const parent );
 
  static string catalogName() { return "MultivariableTableFunction"; }
 
  void setTableCoordinates( integer const numDims,
                            integer const numOps,
                            real64_array const & axisMinimums,
                            real64_array const & axisMaximums,
                            integer_array const & axisPoints );
 
  void setTableValues( real64_array const values );
 
 
 
  virtual void initializeFunction() override;
 
  void initializeFunctionFromFile( string const & filename );
 
 
  void evaluate( dataRepository::Group const & group,
                 real64 const time,
                 SortedArrayView< localIndex const > const & set,
                 arrayView1d< real64 > const & result ) const override final
  {
    GEOS_UNUSED_VAR( group );
    GEOS_UNUSED_VAR( time );
    GEOS_UNUSED_VAR( set );
    GEOS_UNUSED_VAR( result );
 
    GEOS_ERROR( "This method is not supported by MultivariableTableFunction" );
 
  };
 
  virtual real64 evaluate( real64 const * const input ) const override final
  {
    GEOS_UNUSED_VAR( input );
 
    GEOS_ERROR( "This method is not supported by MultivariableTableFunction" );
    return 0;
  };
 
  arrayView1d< real64 const > getAxisMinimums() const { return m_axisMinimums.toViewConst(); }
 
  arrayView1d< real64 const > getAxisMaximums() const { return m_axisMaximums.toViewConst(); }
 
  arrayView1d< integer const > getAxisPoints() const { return m_axisPoints.toViewConst(); }
 
 
  arrayView1d< real64 const > getAxisSteps() const { return m_axisSteps.toViewConst(); }
 
  arrayView1d< real64 const > getAxisStepInvs() const { return m_axisStepInvs.toViewConst(); }
 
  arrayView1d< globalIndex const > getAxisHypercubeMults() const { return m_axisHypercubeMults.toViewConst(); }
 
  arrayView1d< real64 const > getHypercubeData() const { return m_hypercubeData.toViewConst(); }
 
  integer  numDims() const {return m_numDims;};
 
  integer  numOps() const {return m_numOps;};
 
private:
 
  void getHypercubePoints( globalIndex const hypercubeIndex, globalIndex_array & hypercubePoints ) const;
 
  integer m_numDims;
 
  integer m_numOps;
 
  integer m_numVerts;
 
  real64_array m_axisMinimums;
 
  real64_array m_axisMaximums;
 
  integer_array m_axisPoints;
 
  // inputs : data derived from table coordinates data
 
  real64_array m_axisSteps;
 
  real64_array m_axisStepInvs;
 
  globalIndex_array m_axisPointMults;
 
  globalIndex_array m_axisHypercubeMults;
 
  // inputs: operator sample data
 
  real64_array m_pointData;
 
  real64_array m_hypercubeData;
};
 
 
} /* namespace geos */
 
#endif /* GEOS_FUNCTIONS_MULTIVARIABLETABLEFUNCTION_HPP_ */