Flow123d  master-f44eb46
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Private Attributes | List of all members
FieldValue_< 1, 1, ET > Class Template Reference

#include <field_values.hh>

Public Types

typedef ET element_type
 
typedef internal::ReturnType< 1, 1, ET >::return_type return_type
 
typedef internal::InputType< ET >::type ElementInputType
 
typedef internal::AccessTypeDispatch< ET >::type AccessType
 

Public Member Functions

 FieldValue_ (return_type &val)
 
const ET * mem_ptr () const
 
void init_from_input (Input::Array rec)
 
void set_n_comp (unsigned int)
 
unsigned int n_cols () const
 
unsigned int n_rows () const
 
ET & operator() (unsigned int, unsigned int)
 
ET operator() (unsigned int, unsigned int) const
 
 operator return_type () const
 
void zeros ()
 
void eye ()
 
void ones ()
 
bool equal_to (const return_type &other)
 
void scale (double scale_coef)
 

Static Public Member Functions

static std::string type_name ()
 
static constexpr bool is_scalable ()
 
static const return_type & from_raw (return_type &val, ET *raw_data)
 
static return_type get_from_array (const Armor::Array< element_type > &arr, uint idx)
 Casts value stored in Armor::Array to return type. More...
 

Static Public Attributes

static const int NRows_ = 1
 
static const int NCols_ = 1
 
static const int rank_ = 0
 

Private Attributes

return_type & value_
 

Detailed Description

template<class ET>
class FieldValue_< 1, 1, ET >

Specialization for scalars

Definition at line 326 of file field_values.hh.

Member Typedef Documentation

◆ AccessType

template<class ET >
typedef internal::AccessTypeDispatch<ET>::type FieldValue_< 1, 1, ET >::AccessType

Definition at line 331 of file field_values.hh.

◆ element_type

template<class ET >
typedef ET FieldValue_< 1, 1, ET >::element_type

Definition at line 328 of file field_values.hh.

◆ ElementInputType

template<class ET >
typedef internal::InputType<ET>::type FieldValue_< 1, 1, ET >::ElementInputType

Definition at line 330 of file field_values.hh.

◆ return_type

template<class ET >
typedef internal::ReturnType<1, 1, ET>::return_type FieldValue_< 1, 1, ET >::return_type

Definition at line 329 of file field_values.hh.

Constructor & Destructor Documentation

◆ FieldValue_()

template<class ET >
FieldValue_< 1, 1, ET >::FieldValue_ ( return_type &  val)
inline

Definition at line 341 of file field_values.hh.

Member Function Documentation

◆ equal_to()

template<class ET >
bool FieldValue_< 1, 1, ET >::equal_to ( const return_type &  other)
inline

Definition at line 393 of file field_values.hh.

◆ eye()

template<class ET >
void FieldValue_< 1, 1, ET >::eye ( )
inline

Definition at line 386 of file field_values.hh.

◆ from_raw()

template<class ET >
static const return_type& FieldValue_< 1, 1, ET >::from_raw ( return_type &  val,
ET *  raw_data 
)
inlinestatic

Returns reference to the return_type (i.e. double, or arma::vec or arma::mat); with data provided by the parameter raw_data. A reference to a work space val has to be provided for efficient work with vector and matrix values.

Definition at line 347 of file field_values.hh.

◆ get_from_array()

template<class ET >
static return_type FieldValue_< 1, 1, ET >::get_from_array ( const Armor::Array< element_type > &  arr,
uint  idx 
)
inlinestatic

Casts value stored in Armor::Array to return type.

Definition at line 351 of file field_values.hh.

◆ init_from_input()

template<class ET >
void FieldValue_< 1, 1, ET >::init_from_input ( Input::Array  rec)
inline

Definition at line 355 of file field_values.hh.

◆ is_scalable()

template<class ET >
static constexpr bool FieldValue_< 1, 1, ET >::is_scalable ( )
inlinestaticconstexpr

Definition at line 337 of file field_values.hh.

◆ mem_ptr()

template<class ET >
const ET* FieldValue_< 1, 1, ET >::mem_ptr ( ) const
inline

Definition at line 348 of file field_values.hh.

◆ n_cols()

template<class ET >
unsigned int FieldValue_< 1, 1, ET >::n_cols ( ) const
inline

Definition at line 370 of file field_values.hh.

◆ n_rows()

template<class ET >
unsigned int FieldValue_< 1, 1, ET >::n_rows ( ) const
inline

Definition at line 372 of file field_values.hh.

◆ ones()

template<class ET >
void FieldValue_< 1, 1, ET >::ones ( )
inline

Definition at line 390 of file field_values.hh.

◆ operator return_type()

template<class ET >
FieldValue_< 1, 1, ET >::operator return_type ( ) const
inline

Definition at line 378 of file field_values.hh.

◆ operator()() [1/2]

template<class ET >
ET& FieldValue_< 1, 1, ET >::operator() ( unsigned int  ,
unsigned int   
)
inline

Definition at line 374 of file field_values.hh.

◆ operator()() [2/2]

template<class ET >
ET FieldValue_< 1, 1, ET >::operator() ( unsigned int  ,
unsigned int   
) const
inline

Definition at line 376 of file field_values.hh.

◆ scale()

template<class ET >
void FieldValue_< 1, 1, ET >::scale ( double  scale_coef)
inline

Definition at line 397 of file field_values.hh.

◆ set_n_comp()

template<class ET >
void FieldValue_< 1, 1, ET >::set_n_comp ( unsigned int  )
inline

Definition at line 369 of file field_values.hh.

◆ type_name()

template<class ET >
static std::string FieldValue_< 1, 1, ET >::type_name ( )
inlinestatic

Definition at line 336 of file field_values.hh.

◆ zeros()

template<class ET >
void FieldValue_< 1, 1, ET >::zeros ( )
inline

Definition at line 382 of file field_values.hh.

Member Data Documentation

◆ NCols_

template<class ET >
const int FieldValue_< 1, 1, ET >::NCols_ = 1
static

Definition at line 333 of file field_values.hh.

◆ NRows_

template<class ET >
const int FieldValue_< 1, 1, ET >::NRows_ = 1
static

Definition at line 332 of file field_values.hh.

◆ rank_

template<class ET >
const int FieldValue_< 1, 1, ET >::rank_ = 0
static

Definition at line 334 of file field_values.hh.

◆ value_

template<class ET >
return_type& FieldValue_< 1, 1, ET >::value_
private

Definition at line 403 of file field_values.hh.

The documentation for this class was generated from the following file:
Generated by doxygen 1.9.1