dune-vtk 2.8
|
Wrapper class for functions allowing local evaluations. More...
#include <dune/vtk/function.hh>
Public Member Functions | |
template<class LF , class... Args, IsLocalFunction< LF, Element > = true> | |
Function (LF &&localFct, std::string name, std::vector< int > components, Args &&... args) | |
(1) Construct from a LocalFunction directly More... | |
template<class LF , class... Args, IsLocalFunction< LF, Element > = true> | |
Function (LF &&localFct, std::string name, int ncomps, Args &&... args) | |
(2) Construct from a LocalFunction directly More... | |
template<class LF , class... Args, IsLocalFunction< LF, Element > = true, class R = Range<LF,LocalDomain>> | |
Function (LF &&localFct, std::string name, Args &&... args) | |
(3) Construct from a LocalFunction directly. More... | |
template<class... Args> | |
Function (Function< GridView > const &fct, Args &&... args) | |
(4) Construct from a Vtk::Function More... | |
template<class GF , class... Args, disableCopyMove< Function, GF > = 0, IsGridFunction< GF > = true> | |
Function (GF &&fct, std::string name, Args &&... args) | |
(5) Construct from a GridFunction More... | |
template<class F > | |
Function (F &&fct, Vtk::FieldInfo info,...) | |
(6) Constructor that forwards the number of components and data type to the other constructor More... | |
template<class F , class... Args, disableCopyMove< Function, F > = 0, IsGridFunction< F > = true, class = decltype(std::declval<F>().name()), class = decltype(std::declval<F>().numComponents()), class = decltype(std::declval<F>().dataType())> | |
Function (F &&fct,...) | |
(7) Automatically extract name and num components from GridFunction if available More... | |
Function (std::shared_ptr< VTKFunction< GridView > const > const &fct,...) | |
(8) Construct from legacy VTKFunction More... | |
Function ()=default | |
(9) Default constructor. After construction, the function is an an invalid state. More... | |
std::string const & | name () const |
Return a name associated with the function. More... | |
void | setName (std::string name) |
Set the function name. More... | |
int | numComponents () const |
Return the number of components of the Range as it is written to the file. More... | |
void | setComponents (std::vector< int > components) |
Set the components of the Range to visualize. More... | |
void | setComponents (int ncomps) |
Set the number of components of the Range and generate component range [0...ncomps) More... | |
Vtk::DataTypes | dataType () const |
Return the VTK Datatype associated with the functions range type. More... | |
void | setDataType (Vtk::DataTypes type) |
Set the data-type for the components. More... | |
Vtk::RangeTypes | rangeType () const |
The category of the range, SCALAR, VECTOR, TENSOR, or UNSPECIFIED. More... | |
void | setRangeType (Vtk::RangeTypes type, std::size_t ncomp=1) |
Set the category of the range, SCALAR, VECTOR, TENSOR, or UNSPECIFIED. More... | |
void | setFieldInfo (Vtk::FieldInfo info) |
Set all the parameters from a FieldInfo object. More... | |
Wrapper class for functions allowing local evaluations.
|
inline |
(1) Construct from a LocalFunction directly
localFct | A local-function, providing a bind(Element) and an operator()(LocalDomain) |
name | The name to use as identification in the VTK file |
components | A vector of component indices to extract from the range type |
category | The Vtk::RangeTypes category for the range. [Vtk::RangeTypes::UNSPECIFIED] |
dataType | The Vtk::DataTypes used in the output. [Vtk::DataTypes::FLOAT64] |
The arguments category
and dataType
can be passed in any order.
NOTE: Stores the localFunction by value.
|
inline |
(2) Construct from a LocalFunction directly
localFct | A local-function, providing a bind(Element) and an operator()(LocalDomain) |
name | The name to use as identification in the VTK file |
ncomps | Number of components of the pointwise data. Is extracted from the range type of the GridFunction if not given. |
Forwards all the other parmeters to the constructor (1)
NOTE: Stores the localFunction by value.
|
inline |
(3) Construct from a LocalFunction directly.
Same as Constructor (1) or (2) but deduces the number of components from the static range type of the local-function. This defaults to 1 of no static size information could be extracted.
|
inlineexplicit |
(4) Construct from a Vtk::Function
|
inline |
(5) Construct from a GridFunction
fct | A Grid(View)-function, providing a localFunction(fct) |
name | The name to use as identification in the VTK file |
Forwards all other arguments to the constructor (1) or (2).
NOTE: Stores the localFunction(fct) by value.
|
inline |
(6) Constructor that forwards the number of components and data type to the other constructor
|
inlineexplicit |
(7) Automatically extract name and num components from GridFunction if available
|
inlineexplicit |
(8) Construct from legacy VTKFunction
fct | The Dune::VTKFunction to wrap |
|
default |
(9) Default constructor. After construction, the function is an an invalid state.
|
inline |
Return the VTK Datatype associated with the functions range type.
|
inline |
Return a name associated with the function.
|
inline |
Return the number of components of the Range as it is written to the file.
|
inline |
The category of the range, SCALAR, VECTOR, TENSOR, or UNSPECIFIED.
|
inline |
Set the number of components of the Range and generate component range [0...ncomps)
|
inline |
Set the components of the Range to visualize.
|
inline |
Set the data-type for the components.
|
inline |
Set all the parameters from a FieldInfo object.
|
inline |
Set the function name.
|
inline |
Set the category of the range, SCALAR, VECTOR, TENSOR, or UNSPECIFIED.