[dune-pdelab] LocalOperatorInterface: document new types of x and r

[Steffen Müthing]

Hi Ansgar,

I actually never noticed that the particular type of x and r were documented at all. ;-)

Also, thanks for the patch. Unfortunately, it replaces the promise of being passed a
std::vector with different promises (about LocalVector / WeightedVectorAccumulationView).
In fact, we explicitly do not want to make any promises regarding the type of the container,
we only guarantee that it provides a certain interface ( access with operator() in the case
of x and residual accumulation with accumulate() in the case of r, along with some basic
information like size() ).

We should probably write up some interface classes for documentation purposes. But the
important part is: Don't make any assumptions about the type of x and r, just leave them
open as template parameters.

Steffen

Am 01.12.2011 um 16:04 schrieb Ansgar Burchardt:

> Hi,
> 
> the LocalOperatorInterface documents the x (local position in function space) and r (local part of the residual) as having type std::vector.
> However they are now of type LocalVector resp. WeightedVectorAccumulationView.
> 
> It would be nice if the documentation was updated.  A small patch to do so is attached.
> 
> Regards,
> Ansgar
> <0001-LocalOperatorInterface-update-types-of-x-and-r.patch>_______________________________________________
> dune-pdelab mailing list
> dune-pdelab at dune-project.org
> http://lists.dune-project.org/mailman/listinfo/dune-pdelab

Steffen Müthing
Universität Stuttgart
Institut für Parallele und Verteilte Systeme
Universitätsstr. 38
70569 Stuttgart
Tel: +49 711 685 88429
Fax: +49 711 685 88340
Email: steffen.muething at ipvs.uni-stuttgart.de