lf::mesh::utils::MeshFunctionUnary< OP, MF > Class Template Reference

A mesh function representing another mesh function under a pointwise, unary operation. More...

#include <lf/uscalfe/uscalfe.h>

Public Member Functions
	MeshFunctionUnary (OP op, MF mf)
auto	operator() (const mesh::Entity &e, const Eigen::MatrixXd &local) const

Private Attributes
OP	op_
MF	mf_

Related Symbols
(Note that these are not member symbols.)
template<MeshFunction A>
auto	operator- (const A &a) -> MeshFunctionUnary< internal::UnaryOpMinus, A >
	Applies the unary minus operator to a mesh function.
template<MeshFunction A>
auto	squaredNorm (const A &a) -> MeshFunctionUnary< internal::UnaryOpSquaredNorm, A >
	Pointwise squared norm of another mesh function.
template<MeshFunction A>
auto	transpose (const A &a) -> MeshFunctionUnary< internal::UnaryOpTranspose, A >
	Pointwise transpose of an Eigen::Matrix or Eigen::Array
template<MeshFunction A>
auto	adjoint (const A &a) -> MeshFunctionUnary< internal::UnaryOpAdjoint, A >
	Pointwise adjoint of an Eigen::Matrix, i.e. the conjugate transposed of the matrix.
template<MeshFunction A>
auto	conjugate (const A &a) -> MeshFunctionUnary< internal::UnaryOpConjugate, A >
	Pointwise conjuagte of an Eigen::Matrix, Eigen::Array or scalar valued mesh function.

Detailed Description

template<class OP, class MF>
class lf::mesh::utils::MeshFunctionUnary< OP, MF >

A mesh function representing another mesh function under a pointwise, unary operation.

Template Parameters

OP	The operator that should be applied (see below)
MF	The type of the original mesh function.

Requirements for OP

The Operator OP must fulfill the following requirements:

• It must be moveable
• It should overload operator() as follows:

  template <class U>
  std::vector<Z> operator()(const std::vector<U>& u, int)

  where U is the MeshFunctionReturnType of the original MeshFunction, and Z is the type of the mesh function OP MF.

Note

Usually there is no need to use MeshFunctionUnary directly. There are a number of operator overloads which use MeshFunctionUnary internally.

Definition at line 39 of file mesh_function_unary.h.

Constructor & Destructor Documentation

MeshFunctionUnary()

template<class OP, class MF>

lf::mesh::utils::MeshFunctionUnary< OP, MF >::MeshFunctionUnary ( OP op, MF mf )

inline

Definition at line 41 of file mesh_function_unary.h.

References mf_, and op_.

Referenced by adjoint(), conjugate(), operator-(), squaredNorm(), and transpose().

Member Function Documentation

operator()()

template<class OP, class MF>

auto lf::mesh::utils::MeshFunctionUnary< OP, MF >::operator() ( const mesh::Entity & e, const Eigen::MatrixXd & local ) const

inline

Definition at line 43 of file mesh_function_unary.h.

References mf_, and op_.

Friends And Related Symbol Documentation

adjoint()

template<MeshFunction A>

auto adjoint ( const A & a ) -> MeshFunctionUnary<internal::UnaryOpAdjoint, A>

related

Pointwise adjoint of an Eigen::Matrix, i.e. the conjugate transposed of the matrix.

Template Parameters

A	The type of the original mesh function.

Parameters

a	The original mesh function whose adjoint should be taken.

Returns

MeshFunction representing the pointwise adjoint of a.

Definition at line 308 of file mesh_function_unary.h.

References MeshFunctionUnary().

conjugate()

template<MeshFunction A>

auto conjugate ( const A & a ) -> MeshFunctionUnary<internal::UnaryOpConjugate, A>

related

Pointwise conjuagte of an Eigen::Matrix, Eigen::Array or scalar valued mesh function.

Template Parameters

A	The type of the original mesh function.

Parameters

a	The original mesh function that should be conjugated.

Returns

MeshFunction representing the pointwise conjugate of a.

Definition at line 325 of file mesh_function_unary.h.

References MeshFunctionUnary().

operator-()

template<MeshFunction A>

auto operator- ( const A & a ) -> MeshFunctionUnary<internal::UnaryOpMinus, A>

related

Applies the unary minus operator to a mesh function.

Template Parameters

A	The type of the original mesh function.

Parameters

a	The original mesh function.

Returns

-a, where the minus operator is applied pointwise everywhere on the mesh.

Note

The MeshFunctionReturnType of a must support the minus operator!

Definition at line 263 of file mesh_function_unary.h.

References MeshFunctionUnary().

squaredNorm()

template<MeshFunction A>

auto squaredNorm ( const A & a ) -> MeshFunctionUnary<internal::UnaryOpSquaredNorm, A>

related

Pointwise squared norm of another mesh function.

Template Parameters

A	The type of the wrapped mesh function.

Parameters

a	The original mesh function

Returns

MeshFunction representing |a|^2 (pointwise)

Note

This operator requires a to be either scalar or (eigen-) vector valued.

Definition at line 278 of file mesh_function_unary.h.

References MeshFunctionUnary().

transpose()

template<MeshFunction A>

auto transpose ( const A & a ) -> MeshFunctionUnary<internal::UnaryOpTranspose, A>

related

Pointwise transpose of an Eigen::Matrix or Eigen::Array

Template Parameters

A	The type of the wrapped mesh function.

Parameters

a	The original MeshFunction

Returns

MeshFunction representing the pointwise transpose of a.

Definition at line 291 of file mesh_function_unary.h.

References MeshFunctionUnary().

Member Data Documentation

mf_

template<class OP, class MF>

MF lf::mesh::utils::MeshFunctionUnary< OP, MF >::mf_

private

Definition at line 49 of file mesh_function_unary.h.

Referenced by MeshFunctionUnary(), and operator()().

op_

template<class OP, class MF>

OP lf::mesh::utils::MeshFunctionUnary< OP, MF >::op_

private

Definition at line 48 of file mesh_function_unary.h.

Referenced by MeshFunctionUnary(), and operator()().

---

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

• /home/runner/work/lehrfempp/lehrfempp/lib/lf/mesh/utils/mesh_function_unary.h