GEOSX
Public Types | Static Public Member Functions | List of all members
geosx::FieldSpecificationOp< OP > Struct Template Reference

FieldSpecificationOp. More...

#include <FieldSpecificationOps.hpp>

Public Types

using OpType = OP
 Alias for OP, the operator.
 

Static Public Member Functions

template<typename T >
static GEOSX_HOST_DEVICE std::enable_if< !traits::is_tensorT< T >, void >::type SpecifyFieldValue (arrayView1d< T > const &field, localIndex const index, integer const component, real64 const value)
 Pointwise application of a value to a field. More...
 
template<typename T >
static GEOSX_HOST_DEVICE std::enable_if< traits::is_tensorT< T >, void >::type SpecifyFieldValue (arrayView1d< T > const &field, localIndex const index, integer const component, real64 const value)
 Pointwise application of value to a field variable. More...
 
template<typename T >
static GEOSX_HOST_DEVICE std::enable_if< !traits::is_tensorT< T >, void >::type ReadFieldValue (arrayView1d< T const > const &field, localIndex const index, integer const component, real64 &value)
 Read a field value. More...
 
template<typename T >
static GEOSX_HOST_DEVICE std::enable_if< traits::is_tensorT< T >, void >::type ReadFieldValue (arrayView1d< T const > const &field, localIndex const index, integer const component, real64 &value)
 Read a field value. More...
 
template<typename T , int USD>
static GEOSX_HOST_DEVICE std::enable_if< !traits::is_tensorT< T >, void >::type SpecifyFieldValue (arrayView2d< T, USD > const &field, localIndex const index, integer const component, real64 const value)
 Pointwise application of a value to a field variable. More...
 
template<typename T , int USD>
static GEOSX_HOST_DEVICE std::enable_if< traits::is_tensorT< T >, void >::type SpecifyFieldValue (arrayView2d< T, USD > const &field, localIndex const index, integer const component, real64 const value)
 Pointwise application of a value to a field variable. More...
 
template<typename T , int USD>
static GEOSX_HOST_DEVICE std::enable_if< !traits::is_tensorT< T >, void >::type ReadFieldValue (arrayView2d< T const, USD > const &field, localIndex const index, integer const component, real64 &value)
 Read value from a 2d field. More...
 
template<typename T , int USD>
static GEOSX_HOST_DEVICE std::enable_if< traits::is_tensorT< T >, void >::type ReadFieldValue (arrayView2d< T const, USD > const &field, localIndex const index, integer const component, real64 &value)
 This function is not meaningful. It exists for generic purposes, but will result in an error if called. More...
 
template<typename T , int USD>
static GEOSX_HOST_DEVICE std::enable_if< !traits::is_tensorT< T >, void >::type SpecifyFieldValue (arrayView3d< T, USD > const &field, localIndex const index, integer const component, real64 const value)
 Pointwise application of a value to a field variable. More...
 
template<typename T , int USD>
static GEOSX_HOST_DEVICE std::enable_if< traits::is_tensorT< T >, void >::type SpecifyFieldValue (arrayView3d< T, USD > const &field, localIndex const index, integer const component, real64 const value)
 Pointwise application of a value to a field variable. More...
 
template<typename T , int USD>
static GEOSX_HOST_DEVICE void ReadFieldValue (arrayView3d< T const, USD > const &field, localIndex const index, integer const component, real64 &value)
 This function is not meaningful. It exists for generic purposes, but will result in an error if called. More...
 

Detailed Description

template<typename OP>
struct geosx::FieldSpecificationOp< OP >

FieldSpecificationOp.

Definition at line 71 of file FieldSpecificationOps.hpp.

Member Function Documentation

◆ ReadFieldValue() [1/5]

template<typename OP>
template<typename T >
static GEOSX_HOST_DEVICE std::enable_if< !traits::is_tensorT< T >, void >::type geosx::FieldSpecificationOp< OP >::ReadFieldValue ( arrayView1d< T const > const &  field,
localIndex const  index,
integer const  component,
real64 value 
)
inlinestatic

Read a field value.

Template Parameters
TThe type of the array1d field variable specified in field.
Parameters
[in]fieldThe array1d field variable to read value from.
[in]indexThe index in field to read value from.
[in]componentnot used.
[out]valueThe value read from field.
Returns
type of the input field value.

This function performs value (+)= field[index].

Definition at line 136 of file FieldSpecificationOps.hpp.

◆ ReadFieldValue() [2/5]

template<typename OP>
template<typename T >
static GEOSX_HOST_DEVICE std::enable_if< traits::is_tensorT< T >, void >::type geosx::FieldSpecificationOp< OP >::ReadFieldValue ( arrayView1d< T const > const &  field,
localIndex const  index,
integer const  component,
real64 value 
)
inlinestatic

Read a field value.

Template Parameters
TThe type of the array1d field variable specified in field.
Parameters
[in]fieldThe array1d field variable to read value from.
[in]indexThe index in field to read value from.
[in]componentnot used.
[out]valueThe value read from field.
Returns
type of the input field value.

This function performs value (+)= field[index][component].

Definition at line 159 of file FieldSpecificationOps.hpp.

◆ ReadFieldValue() [3/5]

template<typename OP>
template<typename T , int USD>
static GEOSX_HOST_DEVICE std::enable_if< !traits::is_tensorT< T >, void >::type geosx::FieldSpecificationOp< OP >::ReadFieldValue ( arrayView2d< T const, USD > const &  field,
localIndex const  index,
integer const  component,
real64 value 
)
inlinestatic

Read value from a 2d field.

Template Parameters
TThe type of the array2d field variable specified in field.
USDthe unit stride dimension of the array field.
Parameters
[in]fieldThe array2d field variable to read value from.
[in]indexThe index in field to read value from.
[in]componentThe index along second dimension of 2d array.
[out]valueThe value that is read from field.
Returns
type of the input field value.

This function performs value (+)= field[index][component].

Definition at line 255 of file FieldSpecificationOps.hpp.

◆ ReadFieldValue() [4/5]

template<typename OP>
template<typename T , int USD>
static GEOSX_HOST_DEVICE std::enable_if< traits::is_tensorT< T >, void >::type geosx::FieldSpecificationOp< OP >::ReadFieldValue ( arrayView2d< T const, USD > const &  field,
localIndex const  index,
integer const  component,
real64 value 
)
inlinestatic

This function is not meaningful. It exists for generic purposes, but will result in an error if called.

Template Parameters
TThe type of the array2d field variable specified in field.
USDthe unit stride dimension of the array field.
Parameters
[in]fieldThe array2d field variable to read value from.
[in]indexThe index in field to read value from.
[in]componentThe index along second dimension of 2d array.
[out]valueThe value that is read from field.
Returns
type of the input field value.

Definition at line 277 of file FieldSpecificationOps.hpp.

◆ ReadFieldValue() [5/5]

template<typename OP>
template<typename T , int USD>
static GEOSX_HOST_DEVICE void geosx::FieldSpecificationOp< OP >::ReadFieldValue ( arrayView3d< T const, USD > const &  field,
localIndex const  index,
integer const  component,
real64 value 
)
inlinestatic

This function is not meaningful. It exists for generic purposes, but will result in an error if called.

Template Parameters
TThe type of the array2d field variable specified in field.
USDthe unit stride dimension of the array field.
Parameters
[in]fieldThe array2d field variable to read value from.
[in]indexThe index in field to read value from.
[in]componentThe index along second dimension of 2d array.
[out]valueThe value that is read from field.

Definition at line 386 of file FieldSpecificationOps.hpp.

◆ SpecifyFieldValue() [1/6]

template<typename OP>
template<typename T >
static GEOSX_HOST_DEVICE std::enable_if< !traits::is_tensorT< T >, void >::type geosx::FieldSpecificationOp< OP >::SpecifyFieldValue ( arrayView1d< T > const &  field,
localIndex const  index,
integer const  component,
real64 const  value 
)
inlinestatic

Pointwise application of a value to a field.

Template Parameters
TThe type of the array1d field variable specified in field.
Parameters
[in]fieldThe array1d field variable to apply value to.
[in]indexThe index in field to apply value to.
[in]componentnot used.
[in]valueThe value to apply to field.
Returns
type of the field value.

This function performs field[index] (+)= value.

Definition at line 90 of file FieldSpecificationOps.hpp.

◆ SpecifyFieldValue() [2/6]

template<typename OP>
template<typename T >
static GEOSX_HOST_DEVICE std::enable_if< traits::is_tensorT< T >, void >::type geosx::FieldSpecificationOp< OP >::SpecifyFieldValue ( arrayView1d< T > const &  field,
localIndex const  index,
integer const  component,
real64 const  value 
)
inlinestatic

Pointwise application of value to a field variable.

Template Parameters
TThe type of the array1d field variable specified in field.
Parameters
[in]fieldThe array1d field variable to apply value to.
[in]indexThe index in field to apply value to.
[in]componentThe component of field to apply value to. If T is a scalar type, this will not be used.
[in]valueThe value to apply to field.
Returns
type of the field value.

This function performs field[index][component] (+)= value.

Definition at line 114 of file FieldSpecificationOps.hpp.

◆ SpecifyFieldValue() [3/6]

template<typename OP>
template<typename T , int USD>
static GEOSX_HOST_DEVICE std::enable_if< !traits::is_tensorT< T >, void >::type geosx::FieldSpecificationOp< OP >::SpecifyFieldValue ( arrayView2d< T, USD > const &  field,
localIndex const  index,
integer const  component,
real64 const  value 
)
inlinestatic

Pointwise application of a value to a field variable.

Template Parameters
TThe type of the array2d field variable specified in field.
USDthe unit stride dimension of the array field.
Parameters
[in]fieldThe array2d field variable to apply value to.
[in]indexThe index in field to apply value to.
[in]componentThe index along second dimension of 2d array.
[in]valueThe value to apply to field.
Returns
type of the field value.

This function performs field[index][component] (+)= value.

Definition at line 182 of file FieldSpecificationOps.hpp.

◆ SpecifyFieldValue() [4/6]

template<typename OP>
template<typename T , int USD>
static GEOSX_HOST_DEVICE std::enable_if< traits::is_tensorT< T >, void >::type geosx::FieldSpecificationOp< OP >::SpecifyFieldValue ( arrayView2d< T, USD > const &  field,
localIndex const  index,
integer const  component,
real64 const  value 
)
inlinestatic

Pointwise application of a value to a field variable.

Template Parameters
TThe type of the array2d field variable specified in field.
USDthe unit stride dimension of the array field.
Parameters
[in]fieldThe array2d field variable to apply value to.
[in]indexThe index in field to apply value to.
[in]componentThe component of field to apply value to. If T is a scalar type, this will not be used.
[in]valueThe value to apply to field.
Returns
type of the field value.

This function performs field[index][component] (+)= value for all values of field[index].

Definition at line 216 of file FieldSpecificationOps.hpp.

◆ SpecifyFieldValue() [5/6]

template<typename OP>
template<typename T , int USD>
static GEOSX_HOST_DEVICE std::enable_if< !traits::is_tensorT< T >, void >::type geosx::FieldSpecificationOp< OP >::SpecifyFieldValue ( arrayView3d< T, USD > const &  field,
localIndex const  index,
integer const  component,
real64 const  value 
)
inlinestatic

Pointwise application of a value to a field variable.

Template Parameters
TThe type of the array2d field variable specified in field.
USDthe unit stride dimension of the array field.
Parameters
[in]fieldThe array2d field variable to apply value to.
[in]indexThe index in field to apply value to.
[in]componentThe index along third dimension of 3d array.
[in]valueThe value to apply to field.
Returns
type of the field value.

This function performs field[index] (+)= value for all values of field[index].

Definition at line 304 of file FieldSpecificationOps.hpp.

◆ SpecifyFieldValue() [6/6]

template<typename OP>
template<typename T , int USD>
static GEOSX_HOST_DEVICE std::enable_if< traits::is_tensorT< T >, void >::type geosx::FieldSpecificationOp< OP >::SpecifyFieldValue ( arrayView3d< T, USD > const &  field,
localIndex const  index,
integer const  component,
real64 const  value 
)
inlinestatic

Pointwise application of a value to a field variable.

Template Parameters
TThe type of the array2d field variable specified in field.
USDthe unit stride dimension of the array field.
Parameters
[in]fieldThe array2d field variable to apply value to.
[in]indexThe index in field to apply value to.
[in]componentThe component of field to apply value to. If T is a scalar type, this will not be used.
[in]valueThe value to apply to field.
Returns
type of the field value.

This function performs field[index][component] (+)= value for all values of field[index].

Definition at line 344 of file FieldSpecificationOps.hpp.


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