TableFunction.hpp

Go to the documentation of this file.

/*
 * ------------------------------------------------------------------------------------------------------------
 * SPDX-License-Identifier: LGPL-2.1-only
 *
 * Copyright (c) 2018-2020 Lawrence Livermore National Security LLC
 * Copyright (c) 2018-2020 The Board of Trustees of the Leland Stanford Junior University
 * Copyright (c) 2018-2020 Total, S.A
 * Copyright (c) 2019-     GEOSX Contributors
 * All rights reserved
 *
 * See top level LICENSE, COPYRIGHT, CONTRIBUTORS, NOTICE, and ACKNOWLEDGEMENTS files for details.
 * ------------------------------------------------------------------------------------------------------------
 */

#ifndef GEOSX_MANAGERS_FUNCTIONS_TABLEFUNCTION_HPP_
#define GEOSX_MANAGERS_FUNCTIONS_TABLEFUNCTION_HPP_

#include "common/EnumStrings.hpp"
#include "managers/Functions/FunctionBase.hpp"

namespace geosx
{

class TableFunction : public FunctionBase
{
public:
  TableFunction( const std::string & name,
                 dataRepository::Group * const parent );

  virtual ~TableFunction() override;

  static string CatalogName() { return "TableFunction"; }

  template< typename T >
  void parse_file( array1d< T > & target, string const & filename, char delimiter );

  virtual void InitializeFunction() override;

  void reInitializeFunction();

  virtual void Evaluate( dataRepository::Group const * const group,
                         real64 const time,
                         SortedArrayView< localIndex const > const & set,
                         real64_array & result ) const override final
  {
    FunctionBase::EvaluateT< TableFunction >( group, time, set, result );
  }

  virtual real64 Evaluate( real64 const * const input ) const override final;

  array1d< real64_array > const & getCoordinates() const { return m_coordinates; }

  array1d< real64_array > & getCoordinates()       { return m_coordinates; }

  array1d< real64 > const & getValues() const { return m_values; }

  array1d< real64 > & getValues()       { return m_values; }

  enum class InterpolationType : integer
  {
    Linear,
    Nearest,
    Upper,
    Lower
  };

  void setInterpolationMethod( InterpolationType const method ) { m_interpolationMethod = method; }

  void setTableCoordinates( array1d< real64_array > coordinates ) { m_coordinates = coordinates; }

  void setTableValues( real64_array values ) { m_values = values; }

private:
  real64_array m_tableCoordinates1D;

  path_array m_coordinateFiles;

  Path m_voxelFile;

  InterpolationType m_interpolationMethod;

  array1d< real64_array > m_coordinates;

  real64_array m_values;

  static localIndex constexpr m_maxDimensions = 4;

  localIndex m_dimensions;

  localIndex_array m_size;

  localIndex_array m_indexIncrement;

  localIndex m_corners[m_maxDimensions][16];

  localIndex m_numCorners;
};

ENUM_STRINGS( TableFunction::InterpolationType, "linear", "nearest", "upper", "lower" )


} /* namespace geosx */

#endif /* GEOSX_MANAGERS_FUNCTIONS_TABLEFUNCTION_HPP_ */