DUNE-FEM (unstable)

Dune::Fem::ExplicitFieldVector< T, N > Class Template Reference

Public Types

using size_type = typename Base::size_type
 The type used for the index access and size operation.
 
using value_type = typename Base::value_type
 The type of the elements stored in the vector.
 
using reference = value_type &
 The type used for references to the vector entries.
 
using const_reference = const value_type &
 The type used for const references to the vector entries.
 
typedef Traits::derived_type derived_type
 type of derived vector class
 
typedef FieldTraits< value_type >::field_type field_type
 export the type representing the field
 
typedef Traits::value_type block_type
 export the type representing the components
 
typedef DenseIterator< DenseVector, value_typeIterator
 Iterator class for sequential access.
 
typedef Iterator iterator
 typedef for stl compliant access
 
typedef DenseIterator< const DenseVector, const value_typeConstIterator
 ConstIterator class for sequential access.
 
typedef ConstIterator const_iterator
 typedef for stl compliant access
 

Public Member Functions

constexpr ExplicitFieldVector ()
 Constructor making default-initialized vector.
 
template<class... Args, disableCopyMove< ThisType, Args... > = 0, std::enable_if_t< std::is_constructible< BaseType, Args &&... >::value, int > = 0>
 ExplicitFieldVector (Args &&... args)
 
template<class C >
 ExplicitFieldVector (const DenseVector< C > &x, typename std::enable_if<(IsFieldVectorSizeCorrect< C, N >::value &&AcceptElementImplicitConstruction< C, T >::value) >::type *dummy=0)
 
template<typename C , std::enable_if_t<(N==1 &&AcceptElementImplicitConstruction< C, T >::value &&std::is_assignable< T, C >::value &&! std::is_base_of< DenseVector< typename FieldTraits< T >::field_type >, T >::value), int > = 0>
ExplicitFieldVectoroperator= (const C &c)
 Assignment operator for scalar.
 
ExplicitFieldVectoroperator= (const ExplicitFieldVector &other)
 copy assignment operator
 
 explicit (SIZE !=1) const expr FieldVector(const value_type &value) noexcept
 Constructor with a given value initializing all entries to this value.
 
 explicit (SIZE !=1) const expr FieldVector(const S &scalar) noexcept(std::is_nothrow_constructible_v< T, S >)
 Constructor with a given scalar initializing all entries to this value.
 
constexpr size_type size () const
 size method
 
constexpr bool operator== (const DenseVector< Other > &x) const
 Binary vector comparison.
 
constexpr PromotionTraits< field_type, typenameDenseVector< Other >::field_type >::PromotedType operator* (const DenseVector< Other > &x) const
 indefinite vector dot product \(\left (x^T \cdot y \right)\) which corresponds to Petsc's VecTDot More...
 
constexpr derived_type operator+ (const DenseVector< Other > &b) const
 Binary vector addition.
 
constexpr derived_type operator- (const DenseVector< Other > &b) const
 Binary vector subtraction.
 
constexpr derived_type operator- () const
 Vector negation.
 
constexpr value_typefront ()
 return reference to first element
 
constexpr const value_typefront () const
 return reference to first element
 
constexpr value_typeback ()
 return reference to last element
 
constexpr const value_typeback () const
 return reference to last element
 
constexpr bool empty () const
 checks whether the container is empty
 
constexpr Iterator begin ()
 begin iterator
 
constexpr ConstIterator begin () const
 begin ConstIterator
 
constexpr Iterator end ()
 end iterator
 
constexpr ConstIterator end () const
 end ConstIterator
 
constexpr Iterator beforeEnd ()
 
constexpr ConstIterator beforeEnd () const
 
constexpr Iterator beforeBegin ()
 
constexpr ConstIterator beforeBegin () const
 
constexpr Iterator find (size_type i)
 return iterator to given element or end()
 
constexpr ConstIterator find (size_type i) const
 return iterator to given element or end()
 
constexpr derived_typeoperator+= (const DenseVector< Other > &x)
 vector space addition
 
constexpr std::enable_if< std::is_convertible< ValueType, value_type >::value, derived_type >::type & operator+= (const ValueType &kk)
 vector space add scalar to all comps More...
 
constexpr derived_typeoperator-= (const DenseVector< Other > &x)
 vector space subtraction
 
constexpr std::enable_if< std::is_convertible< ValueType, value_type >::value, derived_type >::type & operator-= (const ValueType &kk)
 vector space subtract scalar from all comps More...
 
constexpr std::enable_if< std::is_convertible< FieldType, field_type >::value, derived_type >::type & operator*= (const FieldType &kk)
 vector space multiplication with scalar More...
 
constexpr std::enable_if< std::is_convertible< FieldType, field_type >::value, derived_type >::type & operator/= (const FieldType &kk)
 vector space division by scalar More...
 
constexpr bool operator!= (const DenseVector< Other > &x) const
 Binary vector incomparison.
 
constexpr derived_typeaxpy (const field_type &a, const DenseVector< Other > &x)
 vector space axpy operation ( *this += a x )
 
constexpr PromotionTraits< field_type, typenameDenseVector< Other >::field_type >::PromotedType dot (const DenseVector< Other > &x) const
 vector dot product \(\left (x^H \cdot y \right)\) which corresponds to Petsc's VecDot More...
 
constexpr FieldTraits< value_type >::real_type one_norm () const
 one norm (sum over absolute values of entries)
 
constexpr FieldTraits< value_type >::real_type one_norm_real () const
 simplified one norm (uses Manhattan norm for complex values)
 
constexpr FieldTraits< value_type >::real_type two_norm () const
 two norm sqrt(sum over squared values of entries)
 
constexpr FieldTraits< value_type >::real_type two_norm2 () const
 square of two norm (sum over squared values of entries), need for block recursion
 
constexpr FieldTraits< vt >::real_type infinity_norm () const
 infinity norm (maximum of absolute values of entries)
 
constexpr FieldTraits< vt >::real_type infinity_norm () const
 infinity norm (maximum of absolute values of entries)
 
constexpr FieldTraits< vt >::real_type infinity_norm_real () const
 simplified infinity norm (uses Manhattan norm for complex values)
 
constexpr FieldTraits< vt >::real_type infinity_norm_real () const
 simplified infinity norm (uses Manhattan norm for complex values)
 
constexpr size_type N () const
 number of blocks in the vector (are of size 1 here)
 
constexpr size_type dim () const
 dimension of the vector space
 
Element access
constexpr reference operator[] (size_type i)
 Return a reference to the ith element. More...
 
constexpr const_reference operator[] (size_type i) const
 Return a (const) reference to the ith element. More...
 
constexpr T * data () noexcept
 Return pointer to underlying array.
 
constexpr const T * data () const noexcept
 Return pointer to underlying array.
 
constexpr operator const_reference () const noexcept
 Conversion operator.
 
constexpr operator reference () noexcept
 Conversion operator.
 

Static Public Member Functions

Capacity
static constexpr size_type size () noexcept
 Obtain the number of elements stored in the vector.
 

Static Public Attributes

static constexpr int dimension
 The size of this vector.
 
static constexpr int blocklevel
 The number of block levels we contain. This is the leaf, that is, 1.
 

Related Functions

(Note that these are not member functions.)

std::istream & operator>> (std::istream &in, FieldVector< T, SIZE > &v)
 Read a FieldVector from an input stream. More...
 
std::ostream & operator<< (std::ostream &s, const DenseVector< FieldVector< T, SIZE > > &v)
 Write a DenseVector to an output stream. More...
 

Detailed Description

template<class T, int N>
class Dune::Fem::ExplicitFieldVector< T, N >

A variant of FieldVector which does not allow for implicit type-conversion from an to everything.

Constructor & Destructor Documentation

◆ ExplicitFieldVector() [1/2]

template<class T , int N>
template<class... Args, disableCopyMove< ThisType, Args... > = 0, std::enable_if_t< std::is_constructible< BaseType, Args &&... >::value, int > = 0>
Dune::Fem::ExplicitFieldVector< T, N >::ExplicitFieldVector ( Args &&...  args)
inlineexplicit

Redirect any general construction to the base class during explicit conversion

◆ ExplicitFieldVector() [2/2]

template<class T , int N>
template<class C >
Dune::Fem::ExplicitFieldVector< T, N >::ExplicitFieldVector ( const DenseVector< C > &  x,
typename std::enable_if<(IsFieldVectorSizeCorrect< C, N >::value &&AcceptElementImplicitConstruction< C, T >::value) >::type *  dummy = 0 
)
inline

Allow implicit conversion if both vectors are either composed of field-elements of some fields which can be converted into each other or if both vectors are composed of more complicated elements (which can be converted into each other), but do not allow implicit conversion of a FieldVector of scalars into a FieldVector composed of more complicated stuff. In particalar, FunctionSpace::RangeType cannot be implicitly converted to FunctionSpace::HessianRangeType.

Member Function Documentation

◆ beforeBegin() [1/2]

constexpr Iterator Dune::DenseVector< FieldVector< T, SIZE > >::beforeBegin ( )
inlineconstexprinherited
Returns
an iterator that is positioned before the first entry of the vector.

◆ beforeBegin() [2/2]

constexpr ConstIterator Dune::DenseVector< FieldVector< T, SIZE > >::beforeBegin ( ) const
inlineconstexprinherited
Returns
an iterator that is positioned before the first entry of the vector.

◆ beforeEnd() [1/2]

constexpr Iterator Dune::DenseVector< FieldVector< T, SIZE > >::beforeEnd ( )
inlineconstexprinherited
Returns
an iterator that is positioned before the end iterator of the vector, i.e. at the last entry.

◆ beforeEnd() [2/2]

constexpr ConstIterator Dune::DenseVector< FieldVector< T, SIZE > >::beforeEnd ( ) const
inlineconstexprinherited
Returns
an iterator that is positioned before the end iterator of the vector. i.e. at the last element

◆ dot()

constexpr PromotionTraits< field_type, typenameDenseVector< Other >::field_type >::PromotedType Dune::DenseVector< FieldVector< T, SIZE > >::dot ( const DenseVector< Other > &  x) const
inlineconstexprinherited

vector dot product \(\left (x^H \cdot y \right)\) which corresponds to Petsc's VecDot

http://www.mcs.anl.gov/petsc/petsc-current/docs/manualpages/Vec/VecDot.html

Parameters
xother vector
Returns

◆ operator*()

constexpr PromotionTraits< field_type, typenameDenseVector< Other >::field_type >::PromotedType Dune::DenseVector< FieldVector< T, SIZE > >::operator* ( const DenseVector< Other > &  x) const
inlineconstexprinherited

indefinite vector dot product \(\left (x^T \cdot y \right)\) which corresponds to Petsc's VecTDot

http://www.mcs.anl.gov/petsc/petsc-current/docs/manualpages/Vec/VecTDot.html

Parameters
xother vector
Returns

◆ operator*=()

constexpr std::enable_if< std::is_convertible< FieldType, field_type >::value, derived_type >::type & Dune::DenseVector< FieldVector< T, SIZE > >::operator*= ( const FieldType &  kk)
inlineconstexprinherited

vector space multiplication with scalar

we use enable_if to avoid an ambiguity, if the function parameter can be converted to field_type implicitly. (see FS#1457)

The function is only enabled, if the parameter is directly convertible to field_type.

◆ operator+=()

constexpr std::enable_if< std::is_convertible< ValueType, value_type >::value, derived_type >::type & Dune::DenseVector< FieldVector< T, SIZE > >::operator+= ( const ValueType &  kk)
inlineconstexprinherited

vector space add scalar to all comps

we use enable_if to avoid an ambiguity, if the function parameter can be converted to value_type implicitly. (see FS#1457)

The function is only enabled, if the parameter is directly convertible to value_type.

◆ operator-=()

constexpr std::enable_if< std::is_convertible< ValueType, value_type >::value, derived_type >::type & Dune::DenseVector< FieldVector< T, SIZE > >::operator-= ( const ValueType &  kk)
inlineconstexprinherited

vector space subtract scalar from all comps

we use enable_if to avoid an ambiguity, if the function parameter can be converted to value_type implicitly. (see FS#1457)

The function is only enabled, if the parameter is directly convertible to value_type.

◆ operator/=()

constexpr std::enable_if< std::is_convertible< FieldType, field_type >::value, derived_type >::type & Dune::DenseVector< FieldVector< T, SIZE > >::operator/= ( const FieldType &  kk)
inlineconstexprinherited

vector space division by scalar

we use enable_if to avoid an ambiguity, if the function parameter can be converted to field_type implicitly. (see FS#1457)

The function is only enabled, if the parameter is directly convertible to field_type.

◆ operator[]() [1/2]

constexpr reference Dune::FieldVector< T , SIZE >::operator[] ( size_type  i)
inlineconstexprinherited

Return a reference to the ith element.

Exceptions
RangeErrorif index i is out of range [0,SIZE) (only checked if DUNE_CHECK_BOUNDS is defined).

◆ operator[]() [2/2]

constexpr const_reference Dune::FieldVector< T , SIZE >::operator[] ( size_type  i) const
inlineconstexprinherited

Return a (const) reference to the ith element.

Exceptions
RangeErrorif index i is out of range [0,SIZE) (only checked if DUNE_CHECK_BOUNDS is defined).

Friends And Related Function Documentation

◆ operator<<()

std::ostream & operator<< ( std::ostream &  s,
const DenseVector< FieldVector< T, SIZE > > &  v 
)
related

Write a DenseVector to an output stream.

Parameters
[in]sstd :: ostream to write to
[in]vDenseVector to write
Returns
the output stream (s)

◆ operator>>()

std::istream & operator>> ( std::istream &  in,
FieldVector< T , SIZE > &  v 
)
related

Read a FieldVector from an input stream.

Note
This operator is STL compliant, i.e., the content of v is only changed if the read operation is successful.
Parameters
[in]instd :: istream to read from
[out]vFieldVector to be read
Returns
the input stream (in)

The documentation for this class was generated from the following file:
Creative Commons License   |  Legal Statements / Impressum  |  Hosted by TU Dresden & Uni Heidelberg  |  generated with Hugo v0.111.3 (Jun 17, 22:34, 2025)