TensorFunction< rank, dim > Class Template Reference
[Functions]
List of all members.
Detailed Description
template<int rank, int dim>
class TensorFunction< rank, dim >
This class is a model for a tensor valued function. The interface of the class is mostly the same as that for the Function class, with the exception that it does not support vector-valued functions with several components, but that the return type is always tensor-valued. The returned values of the evaluation of objects of this type are always whole tensors, while for the Function
class, one can ask for a specific component only, or use the vector_value
function, which however does not return the value, but rather writes it into the address provided by its second argument. The reason for the different behaviour of the classes is that in the case if tensor valued functions, the size of the argument is known to the compiler a priori, such that the correct amount of memory can be allocated on the stack for the return value; on the other hand, for the vector valued functions, the size is not known to the compiler, so memory has to be allocated on the heap, resulting in relatively expensive copy operations. One can therefore consider this class a specialization of the Function
class for which the size is known. An additional benefit is that tensors of arbitrary rank can be returned, not only vectors, as for them the size can be determined similarly simply.
- Author:
- Guido Kanschat, 1999
Member Typedef Documentation
template<int rank, int dim>
Define typedefs for the return types of the value
functions.
template<int rank, int dim>
Constructor & Destructor Documentation
template<int rank, int dim>
Constructor. May take an initial value for the time variable, which defaults to zero.
template<int rank, int dim>
Virtual destructor; absolutely necessary in this case, as classes are usually not used by their true type, but rather through pointers to this base class.
Member Function Documentation
template<int rank, int dim>
Return the value of the function at the given point.
template<int rank, int dim>
virtual void TensorFunction< rank, dim >::value_list |
( |
const std::vector< Point< dim > > & |
points, |
|
|
std::vector< value_type > & |
values | |
|
) |
| | const [virtual] |
Set values
to the point values of the function at the points
. It is assumed that values
already has the right size, i.e. the same size as the points
array.
template<int rank, int dim>
Return the gradient of the function at the given point.
template<int rank, int dim>
virtual void TensorFunction< rank, dim >::gradient_list |
( |
const std::vector< Point< dim > > & |
points, |
|
|
std::vector< gradient_type > & |
gradients | |
|
) |
| | const [virtual] |
Set gradients
to the gradients of the function at the points
. It is assumed that values
already has the right size, i.e. the same size as the points
array.
The documentation for this class was generated from the following file: