GEOS
Classes | Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | List of all members
geos::TableFunction Class Reference

#include <TableFunction.hpp>

Inheritance diagram for geos::TableFunction:
Inheritance graph
[legend]

Classes

class  KernelWrapper
 
struct  OutputOptions
 Struct containing output options. More...
 
struct  viewKeyStruct
 Struct containing lookup keys for data repository wrappers. More...
 

Public Types

enum class  InterpolationType : integer { Linear , Nearest , Upper , Lower }
 Enumerator of available interpolation types.
 
- Public Types inherited from geos::FunctionBase
using CatalogInterface = dataRepository::CatalogInterface< FunctionBase, string const &, Group *const >
 Alias for the catalog interface.
 
- Public Types inherited from geos::dataRepository::Group
using subGroupMap = MappedVector< Group, Group *, keyType, indexType >
 The template specialization of MappedVector to use for the collection of sub-Group objects.
 
using wrapperMap = MappedVector< WrapperBase, WrapperBase *, keyType, indexType >
 The template specialization of MappedVector to use for the collection wrappers objects.
 
using CatalogInterface = dataRepository::CatalogInterface< Group, string const &, Group *const >
 Type alias for catalog interface used by this class. See CatalogInterface.
 

Public Member Functions

 TableFunction (const string &name, dataRepository::Group *const parent)
 The constructor. More...
 
virtual void initializeFunction () override
 Initialize the table function.
 
void reInitializeFunction ()
 Build the maps used to evaluate the table function.
 
virtual void evaluate (dataRepository::Group const &group, real64 const time, SortedArrayView< localIndex const > const &set, arrayView1d< real64 > const &result) const override final
 Method to evaluate a function on a target object. More...
 
virtual real64 evaluate (real64 const *const input) const override final
 Method to evaluate a function. More...
 
void checkCoord (real64 coord, localIndex dim) const
 Check if the given coordinate is in the bounds of the table coordinates in the specified dimension, throw an exception otherwise. More...
 
integer numDimensions () const
 
ArrayOfArraysView< real64 const > getCoordinates () const
 Get the table axes definitions. More...
 
ArrayOfArraysView< real64getCoordinates ()
 Get the table axes definitions. More...
 
arrayView1d< real64 const > getValues () const
 Get the table values. More...
 
array1d< real64 > & getValues ()
 Get the table values. More...
 
InterpolationType getInterpolationMethod () const
 Get the interpolation method. More...
 
units::Unit getDimUnit (localIndex const dim) const
 
void setInterpolationMethod (InterpolationType const method)
 Set the interpolation method. More...
 
void setTableCoordinates (array1d< real64_array > const &coordinates, std::vector< units::Unit > const &dimUnits={})
 Set the table coordinates. More...
 
void setDimUnits (std::vector< units::Unit > const &dimUnits)
 Set the units of each dimension. More...
 
void setTableValues (real64_array values, units::Unit unit=units::Unknown)
 Set the table values. More...
 
void setValueUnits (units::Unit unit)
 Set the table value units. More...
 
units::Unit getValueUnit () const
 
void outputPVTTableData (OutputOptions const pvtOutputOpts) const
 Print the table(s) in the log and/or CSV files when requested by the user. More...
 
KernelWrapper createKernelWrapper () const
 Create an instance of the kernel wrapper. More...
 
- Public Member Functions inherited from geos::FunctionBase
 FunctionBase (const string &name, dataRepository::Group *const parent)
 Constructor. More...
 
virtual ~FunctionBase () override=default
 destructor
 
integer isFunctionOfTime () const
 Test to see if the function is a 1D function of time. More...
 
real64_array evaluateStats (dataRepository::Group const &group, real64 const time, SortedArray< localIndex > const &set) const
 This generates statistics by applying a function to an object. More...
 
void setInputVarNames (string_array inputVarNames)
 Set the input variable names. More...
 
- Public Member Functions inherited from geos::dataRepository::Group
template<typename LOG_LEVEL_INFO >
std::enable_if_t< geos::is_log_level_info< LOG_LEVEL_INFO >, void > addLogLevel ()
 Append a levelCondition and a log description to the description of the wrapped object given a log info struct. Must be called in constructor. More...
 
virtual bool registerCallback (void *func, const std::type_info &funcType)
 Register a callback function on the group. More...
 
virtual void reinit ()
 Performs re-initialization of certain variable depending on the solver being used.
 
 Group (string const &name, Group *const parent)
 Constructor. More...
 
 Group (string const &name, conduit::Node &rootNode)
 Constructor. More...
 
 Group (Group &&source)=default
 Move constructor. More...
 
virtual ~Group ()
 Destructor, deletes all Groups and Wrappers owned by this Group.
 
 Group ()=delete
 Deleted default constructor.
 
 Group (Group const &)=delete
 Deleted copy constructor.
 
Groupoperator= (Group const &)=delete
 Deleted copy assignment operator. More...
 
Groupoperator= (Group &&)=delete
 Deleted move assignment operator. More...
 
void printDataHierarchy (integer indent=0) const
 Prints the data hierarchy recursively. More...
 
string dumpInputOptions () const
 
string dumpSubGroupsNames () const
 
string dumpWrappersNames () const
 
template<typename T = Group>
T & registerGroup (string const &name, std::unique_ptr< T > newObject)
 Register a new Group as a sub-group of current Group. More...
 
template<typename T = Group>
T & registerGroup (string const &name, T *newObject)
 Register a new Group as a sub-group of current Group. More...
 
template<typename T = Group>
T & registerGroup (string const &name)
 Register a new Group as a sub-group of current Group. More...
 
template<typename T = Group>
T & registerGroup (subGroupMap::KeyIndex const &keyIndex)
 Register a new Group as a sub-group of current Group. More...
 
template<typename T = Group, typename TBASE = Group>
T & registerGroup (string const &name, string const &catalogName)
 Register a new Group as a sub-group of current Group. More...
 
void deregisterGroup (string const &name)
 Removes a child group from this group. More...
 
virtual GroupcreateChild (string const &childKey, string const &childName)
 Creates a new sub-Group using the ObjectCatalog functionality. More...
 
template<typename T = Group, typename KEY = void>
T * getGroupPointer (KEY const &key)
 Return a pointer to a sub-group of the current Group. More...
 
template<typename T = Group, typename KEY = void>
T const * getGroupPointer (KEY const &key) const
 Return a pointer to a sub-group of the current Group. More...
 
template<typename T = Group, typename KEY = void>
T & getGroup (KEY const &key)
 Return a reference to a sub-group of the current Group. More...
 
template<typename T = Group, typename KEY = void>
T const & getGroup (KEY const &key) const
 Return a reference to a sub-group of the current Group. More...
 
template<typename T = Group>
T & getGroupByPath (string const &path)
 Retrieve a group from the hierarchy using a path. More...
 
template<typename T = Group>
T const & getGroupByPath (string const &path) const
 Retrieve a group from the hierarchy using a path. More...
 
subGroupMapgetSubGroups ()
 Get the subgroups object. More...
 
subGroupMap const & getSubGroups () const
 Get the subgroups object. More...
 
localIndex numSubGroups () const
 return the number of sub groups in this Group More...
 
std::vector< stringgetSubGroupsNames () const
 
template<typename T = Group>
bool hasGroup (string const &name) const
 Check whether a sub-group exists. More...
 
template<typename T >
bool hasSubGroupOfType () const
 Check whether a sub-group exists by type. More...
 
template<typename GROUPTYPE = Group, typename ... GROUPTYPES, typename LAMBDA >
void forSubGroups (LAMBDA &&lambda)
 Apply the given functor to subgroups that can be casted to one of specified types. More...
 
template<typename GROUPTYPE = Group, typename ... GROUPTYPES, typename LAMBDA >
void forSubGroups (LAMBDA &&lambda) const
 Apply the given functor to subgroups that can be casted to one of specified types. More...
 
template<typename GROUPTYPE = Group, typename ... GROUPTYPES, typename LAMBDA >
void forSubGroupsIndex (LAMBDA &&lambda)
 Apply the given functor to subgroups that can be casted to one of specified types. More...
 
template<typename GROUPTYPE = Group, typename ... GROUPTYPES, typename LAMBDA >
void forSubGroupsIndex (LAMBDA &&lambda) const
 Apply the given functor to subgroups that can be casted to one of specified types. More...
 
template<typename GROUPTYPE = Group, typename ... GROUPTYPES, typename LOOKUP_CONTAINER , typename LAMBDA >
void forSubGroups (LOOKUP_CONTAINER const &subGroupKeys, LAMBDA &&lambda)
 Apply the given functor to subgroups that can be casted to one of specified types. More...
 
template<typename GROUPTYPE = Group, typename ... GROUPTYPES, typename LOOKUP_CONTAINER , typename LAMBDA >
void forSubGroups (LOOKUP_CONTAINER const &subGroupKeys, LAMBDA &&lambda) const
 Apply the given functor to subgroups that can be casted to one of specified types. More...
 
template<typename LAMBDA >
void forWrappers (LAMBDA &&lambda)
 Apply the given functor to wrappers. More...
 
template<typename LAMBDA >
void forWrappers (LAMBDA &&lambda) const
 Apply the given functor to wrappers. More...
 
template<typename TYPE , typename ... TYPES, typename LAMBDA >
void forWrappers (LAMBDA &&lambda)
 Apply the given functor to wrappers that can be cast to one of specified types. More...
 
template<typename TYPE , typename ... TYPES, typename LAMBDA >
void forWrappers (LAMBDA &&lambda) const
 Apply the given functor to wrappers that can be cast to one of specified types. More...
 
virtual void initialize_postMeshGeneration ()
 initialization post generation of the mesh.
 
void initialize ()
 Run initialization functions on this and all subgroups. More...
 
virtual void initializationOrder (string_array &order)
 Sets the initialization order for sub-Groups. More...
 
void initializePostInitialConditions ()
 Initialization routine to be called after calling ApplyInitialConditions(). More...
 
void postRestartInitializationRecursive ()
 Initialization routine to be called after calling reading a restart file. More...
 
void processInputFileRecursive (xmlWrapper::xmlDocument &xmlDocument, xmlWrapper::xmlNode &targetNode)
 Recursively read values using ProcessInputFile() from the input file and put them into the wrapped values for this group. Also add the includes content to the xmlDocument when Include nodes are encountered. More...
 
void processInputFileRecursive (xmlWrapper::xmlDocument &xmlDocument, xmlWrapper::xmlNode &targetNode, xmlWrapper::xmlNodePos const &nodePos)
 Same as processInputFileRecursive(xmlWrapper::xmlDocument &, xmlWrapper::xmlNode &) but allow to reuse an existing xmlNodePos. More...
 
void postInputInitializationRecursive ()
 Recursively call postInputInitialization() to apply post processing after reading input values.
 
template<typename T , typename TBASE = T>
Wrapper< TBASE > & registerWrapper (string const &name, wrapperMap::KeyIndex::index_type *const rkey=nullptr)
 Create and register a Wrapper around a new object. More...
 
template<typename T , typename TBASE = T>
Wrapper< TBASE > & registerWrapper (Group::wrapperMap::KeyIndex const &viewKey)
 Create and register a Wrapper around a new object. More...
 
template<typename T >
Wrapper< T > & registerWrapper (string const &name, std::unique_ptr< T > newObject)
 Register a Wrapper around a given object and take ownership. More...
 
template<typename T >
Wrapper< T > & registerWrapper (string const &name, T *newObject)
 Register a Wrapper around an existing object, does not take ownership of the object. More...
 
WrapperBaseregisterWrapper (std::unique_ptr< WrapperBase > wrapper)
 Register and take ownership of an existing Wrapper. More...
 
void deregisterWrapper (string const &name)
 Removes a Wrapper from this group. More...
 
void generateDataStructureSkeleton (integer const level)
 Build a complete datastructure for schema generation. More...
 
virtual void expandObjectCatalogs ()
 Expand any catalogs in the data structure.
 
virtual void setSchemaDeviations (xmlWrapper::xmlNode schemaRoot, xmlWrapper::xmlNode schemaParent, integer documentationType)
 Inform the schema generator of any deviations between the xml and GEOS data structures. More...
 
virtual void registerDataOnMeshRecursive (Group &meshBodies)
 Calls RegisterDataOnMesh() recursively. More...
 
virtual void registerDataOnMesh (Group &meshBodies)
 Register data on mesh entities. More...
 
virtual localIndex packSize (string_array const &wrapperNames, integer const recursive, bool onDevice, parallelDeviceEvents &events) const
 Get the size required to pack a list of wrappers. More...
 
virtual localIndex packSize (string_array const &wrapperNames, arrayView1d< localIndex const > const &packList, integer const recursive, bool onDevice, parallelDeviceEvents &events) const
 Get the size required to pack a list of indices within a list of wrappers. More...
 
localIndex packSize (arrayView1d< localIndex const > const &packList, integer const recursive, bool onDevice, parallelDeviceEvents &events) const
 Get the size required to pack a list of indices for all registered wrappers. More...
 
virtual localIndex pack (buffer_unit_type *&buffer, string_array const &wrapperNames, integer const recursive, bool onDevice, parallelDeviceEvents &events) const
 Pack a list of wrappers to a buffer. More...
 
virtual localIndex pack (buffer_unit_type *&buffer, string_array const &wrapperNames, arrayView1d< localIndex const > const &packList, integer const recursive, bool onDevice, parallelDeviceEvents &events) const
 Pack a list of indices within a list of wrappers. More...
 
localIndex pack (buffer_unit_type *&buffer, arrayView1d< localIndex const > const &packList, integer const recursive, bool onDevice, parallelDeviceEvents &events) const
 Pack a list of indices for all registered wrappers. More...
 
virtual localIndex unpack (buffer_unit_type const *&buffer, arrayView1d< localIndex > &packList, integer const recursive, bool onDevice, parallelDeviceEvents &events, MPI_Op op=MPI_REPLACE)
 Unpack a buffer. More...
 
template<typename KEY >
WrapperBase const & getWrapperBase (KEY const &key) const
 Return a reference to a WrapperBase stored in this group. More...
 
template<typename KEY >
WrapperBasegetWrapperBase (KEY const &key)
 Return a reference to a WrapperBase stored in this group. More...
 
indexType getWrapperIndex (string const &name) const
 
wrapperMap const & wrappers () const
 Get access to the internal wrapper storage. More...
 
wrapperMapwrappers ()
 Get access to the internal wrapper storage. More...
 
indexType numWrappers () const
 Return the number of wrappers. More...
 
std::vector< stringgetWrappersNames () const
 
template<typename LOOKUP_TYPE >
bool hasWrapper (LOOKUP_TYPE const &lookup) const
 Check if a wrapper exists. More...
 
template<typename T , typename LOOKUP_TYPE >
Wrapper< T > const & getWrapper (LOOKUP_TYPE const &index) const
 Retrieve a Wrapper stored in this group. More...
 
template<typename T , typename LOOKUP_TYPE >
Wrapper< T > & getWrapper (LOOKUP_TYPE const &index)
 Retrieve a Wrapper stored in this group. More...
 
template<typename T , typename LOOKUP_TYPE >
Wrapper< T > const * getWrapperPointer (LOOKUP_TYPE const &index) const
 Retrieve a Wrapper stored in this group. More...
 
template<typename T , typename LOOKUP_TYPE >
Wrapper< T > * getWrapperPointer (LOOKUP_TYPE const &index)
 Retrieve a Wrapper stored in this group. More...
 
template<typename T , typename LOOKUP_TYPE >
GEOS_DECLTYPE_AUTO_RETURN getReference (LOOKUP_TYPE const &lookup) const
 Look up a wrapper and get reference to wrapped object. More...
 
template<typename T , typename LOOKUP_TYPE >
T & getReference (LOOKUP_TYPE const &lookup)
 Look up a wrapper and get reference to wrapped object. More...
 
virtual void resize (localIndex const newSize)
 Resize the group and all contained wrappers that resize with parent. More...
 
virtual void reserve (indexType const newsize)
 Set the new capacity and reserve it in all wrappers that resize with parent. More...
 
localIndex capacity () const
 Get the "capacity" of the group, which determines the capacity of resizable wrappers. More...
 
localIndex size () const
 Get the "size" of the group, which determines the number of elements in resizable wrappers. More...
 
string const & getName () const
 Get group name. More...
 
string getPath () const
 Return the path of this Group in the data repository. Starts with '/' followed by the hierarchy of the children of the "Problem" in which the Group is. More...
 
DataContext const & getDataContext () const
 
template<typename KEY >
DataContext const & getWrapperDataContext (KEY key) const
 
GroupgetParent ()
 Access the group's parent. More...
 
Group const & getParent () const
 Access the group's parent. More...
 
bool hasParent () const
 
localIndex getIndexInParent () const
 Get the group's index within its parent group. More...
 
localIndex getSubGroupIndex (keyType const &key) const
 Get the index of a sub-Group within this group. More...
 
int sizedFromParent () const
 Check whether this Group is resized when its parent is resized. More...
 
GroupsetSizedFromParent (int val)
 Set whether this wrapper is resized when its parent is resized. More...
 
RestartFlags getRestartFlags () const
 Get flags that control restart output of this group. More...
 
void setRestartFlags (RestartFlags flags)
 Set flags that control restart output of this group. More...
 
InputFlags getInputFlags () const
 Get input flags for schema generation. More...
 
void setInputFlags (InputFlags flags)
 Set input flags for schema generation. More...
 
conduit::Node & getConduitNode ()
 Return the Conduit node object associated with this group. More...
 
conduit::Node const & getConduitNode () const
 Return the Conduit node object associated with this group. More...
 
void prepareToWrite ()
 Register the group and its wrappers with Conduit.
 
void finishWriting ()
 Write the group and its wrappers into Conduit.
 
void loadFromConduit ()
 Read the group and its wrappers from Conduit.
 
void enableLogLevelInput ()
 
void setLogLevel (integer const logLevel)
 Set verbosity level. More...
 
integer getLogLevel () const
 

Static Public Member Functions

static string catalogName ()
 The catalog name interface. More...
 
- Static Public Member Functions inherited from geos::FunctionBase
static CatalogInterface::CatalogTypegetCatalog ()
 return the catalog entry for the function More...
 
static string const & getOutputDirectory ()
 Get the output directory for function output. More...
 
static void setOutputDirectory (string const &outputDir)
 Set the output directory for function output. More...
 
- Static Public Member Functions inherited from geos::dataRepository::Group
template<typename T0 , typename T1 , typename ... CASTTYPES, typename CONTAINERTYPE , typename LAMBDA >
static bool applyLambdaToContainer (CONTAINERTYPE &container, LAMBDA &&lambda)
 Apply a given functor to a container if the container can be cast to one of the specified types. More...
 
static CatalogInterface::CatalogTypegetCatalog ()
 Get the singleton catalog for this Group. More...
 

Static Public Attributes

static constexpr integer maxDimensions = 4
 maximum dimensions for the coordinates in the table
 
- Static Public Attributes inherited from geos::FunctionBase
static constexpr int MAX_VARS = 4
 Maximum total number of independent variables (including components of multidimensional variables)
 

Additional Inherited Members

- Protected Member Functions inherited from geos::FunctionBase
template<typename LEAF , typename POLICY = serialPolicy>
void evaluateT (dataRepository::Group const &group, real64 const time, SortedArrayView< localIndex const > const &set, arrayView1d< real64 > const &result) const
 Method to apply an function with an arbitrary type of output. More...
 
virtual void postInputInitialization () override
 
- Protected Member Functions inherited from geos::dataRepository::Group
virtual void initializePreSubGroups ()
 Called by Initialize() prior to initializing sub-Groups.
 
virtual void initializePostSubGroups ()
 Called by Initialize() after to initializing sub-Groups.
 
virtual void initializePostInitialConditionsPreSubGroups ()
 Called by InitializePostInitialConditions() prior to initializing sub-Groups.
 
virtual void initializePostInitialConditionsPostSubGroups ()
 Called by InitializePostInitialConditions() after to initializing sub-Groups.
 
virtual void postRestartInitialization ()
 Performs initialization required after reading from a restart file.
 
- Protected Attributes inherited from geos::FunctionBase
string_array m_inputVarNames
 names for the input variables
 

Detailed Description

An interface for a dense table-based function

Definition at line 38 of file TableFunction.hpp.

Constructor & Destructor Documentation

◆ TableFunction()

geos::TableFunction::TableFunction ( const string name,
dataRepository::Group *const  parent 
)

The constructor.

Parameters
[in]namethe name of this object manager
[in]parentthe parent Group

Member Function Documentation

◆ catalogName()

static string geos::TableFunction::catalogName ( )
inlinestatic

The catalog name interface.

Returns
name of the TableFunction in the FunctionBase catalog

Definition at line 209 of file TableFunction.hpp.

◆ checkCoord()

void geos::TableFunction::checkCoord ( real64  coord,
localIndex  dim 
) const

Check if the given coordinate is in the bounds of the table coordinates in the specified dimension, throw an exception otherwise.

Parameters
coordthe coordinate in the 'dim' dimension that must be checked
dimthe dimension in which the coordinate must be checked
Exceptions
SimulationErrorif the value is out of the coordinates bounds.

◆ createKernelWrapper()

KernelWrapper geos::TableFunction::createKernelWrapper ( ) const

Create an instance of the kernel wrapper.

Returns
the kernel wrapper

◆ evaluate() [1/2]

virtual void geos::TableFunction::evaluate ( dataRepository::Group const &  group,
real64 const  time,
SortedArrayView< localIndex const > const &  set,
arrayView1d< real64 > const &  result 
) const
inlinefinaloverridevirtual

Method to evaluate a function on a target object.

Parameters
groupa pointer to the object holding the function arguments
timecurrent time
setthe subset of nodes to apply the function to
resultan array to hold the results of the function

Implements geos::FunctionBase.

Definition at line 228 of file TableFunction.hpp.

◆ evaluate() [2/2]

virtual real64 geos::TableFunction::evaluate ( real64 const *const  input) const
finaloverridevirtual

Method to evaluate a function.

Parameters
inputa scalar input
Returns
the function result

Implements geos::FunctionBase.

◆ getCoordinates() [1/2]

ArrayOfArraysView< real64 > geos::TableFunction::getCoordinates ( )
inline

Get the table axes definitions.

Returns
a reference to an array of arrays that define each table axis

Definition at line 266 of file TableFunction.hpp.

◆ getCoordinates() [2/2]

ArrayOfArraysView< real64 const > geos::TableFunction::getCoordinates ( ) const
inline

Get the table axes definitions.

Returns
a reference to an array of arrays that define each table axis

Definition at line 261 of file TableFunction.hpp.

◆ getDimUnit()

units::Unit geos::TableFunction::getDimUnit ( localIndex const  dim) const
inline
Parameters
dimThe coordinate dimension (= axe) we want the Unit.
Returns
The unit of a coordinate dimension, or units::Unknown if no units has been specified.

Definition at line 289 of file TableFunction.hpp.

◆ getInterpolationMethod()

InterpolationType geos::TableFunction::getInterpolationMethod ( ) const
inline

Get the interpolation method.

Returns
The interpolation method

Definition at line 283 of file TableFunction.hpp.

◆ getValues() [1/2]

array1d< real64 >& geos::TableFunction::getValues ( )
inline

Get the table values.

Returns
a reference to the 1d array of table values. For ND arrays, values are stored in Fortran order.

Definition at line 277 of file TableFunction.hpp.

◆ getValues() [2/2]

arrayView1d< real64 const > geos::TableFunction::getValues ( ) const
inline

Get the table values.

Returns
a reference to the 1d array of table values. For ND arrays, values are stored in Fortran order.

Definition at line 272 of file TableFunction.hpp.

◆ getValueUnit()

units::Unit geos::TableFunction::getValueUnit ( ) const
inline
Returns
The table unit

Definition at line 336 of file TableFunction.hpp.

◆ numDimensions()

integer geos::TableFunction::numDimensions ( ) const
inline
Returns
Number of table dimensions

Definition at line 255 of file TableFunction.hpp.

◆ outputPVTTableData()

void geos::TableFunction::outputPVTTableData ( OutputOptions const  pvtOutputOpts) const

Print the table(s) in the log and/or CSV files when requested by the user.

Parameters
pvtOutputOptsStruct containing output options

◆ setDimUnits()

void geos::TableFunction::setDimUnits ( std::vector< units::Unit > const &  dimUnits)
inline

Set the units of each dimension.

Parameters
dimUnitsThe units of each dimension

Definition at line 312 of file TableFunction.hpp.

◆ setInterpolationMethod()

void geos::TableFunction::setInterpolationMethod ( InterpolationType const  method)

Set the interpolation method.

Parameters
methodThe interpolation method

◆ setTableCoordinates()

void geos::TableFunction::setTableCoordinates ( array1d< real64_array > const &  coordinates,
std::vector< units::Unit > const &  dimUnits = {} 
)

Set the table coordinates.

Parameters
coordinatesAn array of arrays containing table coordinate definitions
dimUnitsThe units of each dimension of the coordinates, in the same order

◆ setTableValues()

void geos::TableFunction::setTableValues ( real64_array  values,
units::Unit  unit = units::Unknown 
)

Set the table values.

Parameters
valuesAn array of table values in fortran order
unitThe unit of the given values

◆ setValueUnits()

void geos::TableFunction::setValueUnits ( units::Unit  unit)
inline

Set the table value units.

Parameters
unitThe unit of the values

Definition at line 328 of file TableFunction.hpp.


The documentation for this class was generated from the following file: