From 0dbee184eb2249f8f473fabfef0cb5394b0b3ad0 Mon Sep 17 00:00:00 2001 From: wolf Date: Tue, 1 Jun 1999 13:33:01 +0000 Subject: [PATCH] More doc fixes for doc++. git-svn-id: https://svn.dealii.org/trunk@1361 0785d39b-7218-0410-832d-ea1e28bc413d --- deal.II/base/include/base/tensorindex.h | 116 ++++++++++---------- deal.II/deal.II/include/multigrid/mg_base.h | 44 ++++++-- deal.II/lac/include/lac/mgbase.h | 44 ++++++-- 3 files changed, 121 insertions(+), 83 deletions(-) diff --git a/deal.II/base/include/base/tensorindex.h b/deal.II/base/include/base/tensorindex.h index 51ff5adff9..beb570adaa 100644 --- a/deal.II/base/include/base/tensorindex.h +++ b/deal.II/base/include/base/tensorindex.h @@ -33,13 +33,15 @@ public: TensorIndex(...); /** - * * Access operator returning index * in #n#th component - * */ unsigned int operator () (unsigned int n) const; - DeclException1(ExcRank, int, + + /** + * Exception. + */ + DeclException1(ExcRank, int, << "Index " << arg1 << " higher than maximum " << rank-1); }; @@ -66,10 +68,8 @@ public: /** - * * Access operator returning index * in #n#th component - * */ unsigned int operator () (unsigned int n) const { @@ -88,12 +88,12 @@ private: /** * Field of indices. */ - unsigned index[3]; -public: - /** - * Constructor taking #rank# indices. - */ - TensorIndex(unsigned i0, unsigned i1, unsigned i2) + unsigned index[3]; + public: + /** + * Constructor taking #rank# indices. + */ + TensorIndex(unsigned i0, unsigned i1, unsigned i2) { index[0] = i0; index[1] = i1; @@ -101,95 +101,93 @@ public: } - /** - * - * Access operator returning index - * in #n#th component - * - */ - unsigned operator () (unsigned n) const + /** + * Access operator returning index + * in #n#th component + * + */ + unsigned operator () (unsigned n) const { Assert(n<3, ExcRank(n)); return index[n]; } - DeclException1(ExcRank, unsigned, - << "Index " << arg1 << " higher than maximum 2"); + DeclException1(ExcRank, unsigned, + << "Index " << arg1 << " higher than maximum 2"); }; template<> class TensorIndex<2> { -private: - /** - * Field of indices. - */ - unsigned index[4]; -public: - /** - * Constructor taking #rank# indices. - */ - TensorIndex(unsigned i0, unsigned i1) + private: + /** + * Field of indices. + */ + unsigned index[4]; + public: + /** + * Constructor taking #rank# indices. + */ + TensorIndex(unsigned i0, unsigned i1) { index[0] = i0; index[1] = i1; } - /** - * - * Access operator returning index - * in #n#th component - * - */ - unsigned operator () (unsigned n) const + /** + * Access operator returning index + * in #n#th component + */ + unsigned operator () (unsigned n) const { Assert(n<2, ExcRank(n)); return index[n]; } - DeclException1(ExcRank, unsigned, - << "Index " << arg1 << " higher than maximum 1"); + DeclException1(ExcRank, unsigned, + << "Index " << arg1 << " higher than maximum 1"); }; template<> class TensorIndex<1> { -private: - /** - * Field of indices. - */ - unsigned index[1]; -public: - /** - * Constructor taking #rank# indices. - */ - TensorIndex(unsigned i0) + private: + /** + * Field of indices. + */ + unsigned index[1]; + public: + /** + * Constructor taking #rank# indices. + */ + TensorIndex(unsigned i0) { index[0] = i0; } - /** - * - * Access operator returning index - * in #n#th component - * - */ - unsigned operator () (unsigned n) const + /** + * Access operator returning index + * in #n#th component + */ + unsigned operator () (unsigned n) const { Assert(n<1, ExcRank(n)); return index[n]; } - DeclException1(ExcRank, unsigned, - << "Index " << arg1 << " higher than maximum 0"); + DeclException1(ExcRank, unsigned, + << "Index " << arg1 << " higher than maximum 0"); }; + + template inline unsigned -TensorIndex::operator() (unsigned n) const +TensorIndex:: +operator() (unsigned n) const { Assert(n #include @@ -436,9 +438,11 @@ class PreconditionMG + + template -MGCoarseGridLACIteration -::MGCoarseGridLACIteration(SOLVER& s, const MATRIX& m, const PRECOND& p) +MGCoarseGridLACIteration:: +MGCoarseGridLACIteration(SOLVER& s, const MATRIX& m, const PRECOND& p) : solver(s), matrix(m), precondition(p) {} @@ -451,7 +455,10 @@ MGCoarseGridLACIteration::operator() solver.solve(matrix, dst, src, precondition); } -////////////////////////////////////////////////////////////////////// + + + +/* ------------------------------------------------------------------- */ template MGVector::MGVector(unsigned int min, unsigned int max) @@ -478,7 +485,10 @@ MGVector::operator[](unsigned int i) const return vector::operator[](i-minlevel); } -////////////////////////////////////////////////////////////////////// + + +/* ------------------------------------------------------------------- */ + template MGMatrix::MGMatrix(unsigned int min, unsigned int max) @@ -505,13 +515,16 @@ MGMatrix::operator[](unsigned int i) const return vector::operator[](i-minlevel); } -////////////////////////////////////////////////////////////////////// + + +/* ------------------------------------------------------------------- */ + template PreconditionMG::PreconditionMG(MG& mg, - const MGSmootherBase& pre, - const MGSmootherBase& post, - const MGCoarseGridSolver& coarse) + const MGSmootherBase& pre, + const MGSmootherBase& post, + const MGCoarseGridSolver& coarse) : multigrid(&mg), pre(&pre), @@ -519,9 +532,12 @@ PreconditionMG::PreconditionMG(MG& mg, coarse(&coarse) {} + + template void -PreconditionMG::operator() (VECTOR& dst, const VECTOR& src) const +PreconditionMG::operator() (VECTOR& dst, + const VECTOR& src) const { multigrid->copy_to_mg(src); multigrid->vcycle(*pre, *post, *coarse); @@ -529,4 +545,8 @@ PreconditionMG::operator() (VECTOR& dst, const VECTOR& src) const } + +/*---------------------------- mg_base.h ---------------------------*/ +/* end of #ifndef __mg_base_H */ #endif +/*---------------------------- mg_base.h ---------------------------*/ diff --git a/deal.II/lac/include/lac/mgbase.h b/deal.II/lac/include/lac/mgbase.h index cc71bc98f4..d464b68f08 100644 --- a/deal.II/lac/include/lac/mgbase.h +++ b/deal.II/lac/include/lac/mgbase.h @@ -1,8 +1,10 @@ -// $Id$ +/*---------------------------- mgbase.h ---------------------------*/ +/* $Id$ */ +#ifndef __mgbase_H +#define __mgbase_H +/*---------------------------- mgbase.h ---------------------------*/ -#ifndef __lac_mgbase_h -#define __lac_mgbase_h #include #include @@ -436,9 +438,11 @@ class PreconditionMG + + template -MGCoarseGridLACIteration -::MGCoarseGridLACIteration(SOLVER& s, const MATRIX& m, const PRECOND& p) +MGCoarseGridLACIteration:: +MGCoarseGridLACIteration(SOLVER& s, const MATRIX& m, const PRECOND& p) : solver(s), matrix(m), precondition(p) {} @@ -451,7 +455,10 @@ MGCoarseGridLACIteration::operator() solver.solve(matrix, dst, src, precondition); } -////////////////////////////////////////////////////////////////////// + + + +/* ------------------------------------------------------------------- */ template MGVector::MGVector(unsigned int min, unsigned int max) @@ -478,7 +485,10 @@ MGVector::operator[](unsigned int i) const return vector::operator[](i-minlevel); } -////////////////////////////////////////////////////////////////////// + + +/* ------------------------------------------------------------------- */ + template MGMatrix::MGMatrix(unsigned int min, unsigned int max) @@ -505,13 +515,16 @@ MGMatrix::operator[](unsigned int i) const return vector::operator[](i-minlevel); } -////////////////////////////////////////////////////////////////////// + + +/* ------------------------------------------------------------------- */ + template PreconditionMG::PreconditionMG(MG& mg, - const MGSmootherBase& pre, - const MGSmootherBase& post, - const MGCoarseGridSolver& coarse) + const MGSmootherBase& pre, + const MGSmootherBase& post, + const MGCoarseGridSolver& coarse) : multigrid(&mg), pre(&pre), @@ -519,9 +532,12 @@ PreconditionMG::PreconditionMG(MG& mg, coarse(&coarse) {} + + template void -PreconditionMG::operator() (VECTOR& dst, const VECTOR& src) const +PreconditionMG::operator() (VECTOR& dst, + const VECTOR& src) const { multigrid->copy_to_mg(src); multigrid->vcycle(*pre, *post, *coarse); @@ -529,4 +545,8 @@ PreconditionMG::operator() (VECTOR& dst, const VECTOR& src) const } + +/*---------------------------- mgbase.h ---------------------------*/ +/* end of #ifndef __mgbase_H */ #endif +/*---------------------------- mgbase.h ---------------------------*/ -- 2.39.5