mm::ScalarField< Scalar > Class Template Reference

#include <ScalarField_fwd.hpp>

Detailed Description

template<typename Scalar>
class mm::ScalarField< Scalar >

Represents a discretization of a scalar field, a finite collection of scalars.

This type is fully compatible with Eigen types and can use the same API.

Template Parameters

Scalar

Type of elements in the field.

Usage example:

    ScalarFieldd field(4);
    // set to scalar and multi index access
    field = -3.0;
    field[{0, 2, 3}] = 5.0;
    // usual mathematical operations
    field *= 2.5;
    field += field;
    std::cout << field << std::endl;

Examples

test/end2end/poisson_explicit.cpp.

Definition at line 27 of file ScalarField_fwd.hpp.

Inheritance diagram for mm::ScalarField< Scalar >:

Collaboration diagram for mm::ScalarField< Scalar >:

Public Member Functions
template<typename OtherDerived >
	ScalarField (const Eigen::MatrixBase< OtherDerived > &other)
	This constructor allows construction of ScalarField from Eigen expressions. More...
template<typename OtherDerived >
ScalarField &	operator= (const Eigen::MatrixBase< OtherDerived > &other)
	This method allows assignments of Eigen expressions to ScalarField. More...
ScalarFieldView	operator[] (const indexes_t &indexes)
	Multiindex view to given ScalarField. More...

Public Types
typedef Scalar	scalar_t
	Scalar data type. More...
typedef Eigen::Matrix< Scalar, Eigen::Dynamic, 1 >	Base
	Base class typedef. More...

Classes
class	ScalarFieldView
	Represents a non contiguous view to a scalar field. More...

Constructor & Destructor Documentation

ScalarField()

template<typename Scalar >

template<typename OtherDerived >

mm::ScalarField< Scalar >::ScalarField

(

const Eigen::MatrixBase< OtherDerived > &

other

)

This constructor allows construction of ScalarField from Eigen expressions.

Member Function Documentation

operator=()

template<typename Scalar >

template<typename OtherDerived >

ScalarField& mm::ScalarField< Scalar >::operator=

(

const Eigen::MatrixBase< OtherDerived > &

other

)

This method allows assignments of Eigen expressions to ScalarField.

operator[]()

template<typename Scalar >

ScalarFieldView mm::ScalarField< Scalar >::operator[] ( const indexes_t &  indexes )

inline

Multiindex view to given ScalarField.

Definition at line 67 of file ScalarField_fwd.hpp.

---

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

• include/medusa/bits/types/ScalarField_fwd.hpp