Removed overridden method + some doxygen corrections.

git-svn-id: http://svn.sintef.no/trondheim/IFEM/trunk@2688 e10b68d5-8a6e-419e-a041-bce267b0401d

src/ASM/BDFMats.h

@@ -1,3 +1,4 @@
+// $Id$
 //==============================================================================
 //!
 //! \file BDFMats.h
@@ -16,6 +17,7 @@
 #include "NewmarkMats.h"
 #include "BDF.h"
 
+
 /*!
   \brief Class representing the element matrices for a dynamic FEM problem
   based on Newmark time integration.
@@ -26,20 +28,17 @@ class BDFMats : public NewmarkMats
 public:
   //! \brief The constructor initializes the time integration parameters.
   //! param[in] bdfscheme BDF time discretization scheme
- BDFMats(const TimeIntegration::BDFD2& bdfscheme) : bdf(bdfscheme) {}
+  BDFMats(const TimeIntegration::BDFD2& bdfscheme) : bdf(bdfscheme) {}
   //! \brief Empty destructor.
   virtual ~BDFMats() {}
 
-  //! \brief Updates the time step size and the \a isPredictor flag.
-  void setStepSize(double dt, int iter = 0) { h = dt; }
-
   //! \brief Returns the element-level Newton matrix.
   virtual const Matrix& getNewtonMatrix() const;
   //! \brief Returns the element-level right-hand-side vector.
   virtual const Vector& getRHSVector() const;
 
 protected:
-  TimeIntegration::BDFD2 bdf;    //!< BDF time integration scheme  
+  TimeIntegration::BDFD2 bdf; //!< BDF time integration scheme
 };
 
 #endif

src/SIM/SIMinput.h

@@ -67,13 +67,18 @@ public:
   virtual bool parse(char* keyWord, std::istream& is) = 0;
   //! \brief Parses a data section from an XML element.
   virtual bool parse(const TiXmlElement* elem) = 0;
-  
-  //! \brief Returns process administrator 
+
+  //! \brief Returns the parallel process administrator.
   const ProcessAdm& getProcessAdm() const { return adm; }
 
-  //! \brief Returns the global process ID
-  //! \details Note that this may not be the process ID used in the equation solver
-  int getGlobalProcessID() { return myPid; }
+  //! \brief Returns the global process ID.
+  //! \note May be different from the process ID used in the equation solver.
+  int getGlobalProcessID() const { return myPid; }
+
+  //! \brief Returns the simulator heading.
+  const std::string& getHeading() const { return myHeading; }
+  //! \brief Defines the simulator heading.
+  void setHeading(const std::string& heading) { myHeading = heading; }
 
 protected:
   //! \brief Prints the heading of this (sub-step) solver, if any, to std::cout.
@@ -83,20 +88,13 @@ public:
   static int msgLevel; //!< Controls the amount of console output during solving
   SIMoptions& opt;     //!< Simulation control parameters
 
-  //! \brief Get the heading for the simulator
-  const std::string& getHeading() { return myHeading; }
-
-  //! \brief Set the heading for the simulator
-  //! \param heading The new heading
-  void setHeading(const std::string& heading) { myHeading = heading; }
-
 private:
   SIMoptions myOpts; //!< The actual control parameters owned by this simulator
 
 protected:
   ProcessAdm adm; //!< Parallel administrator
-  int myPid;       //!< Processor ID in parallel simulations
-  int nProc;       //!< Number of processors in parallel simulations
+  int myPid;      //!< Processor ID in parallel simulations
+  int nProc;      //!< Number of processors in parallel simulations
 
   std::string myHeading; //!< Heading written before reading the input file
   std::string inputFile; //!< The parsed input file

src/SIM/SIMoutput.h

@@ -227,7 +227,7 @@ public:
                    bool formatted = false, std::streamsize precision = 3) const;
   //! \brief Dumps vector solution at specified points in ASCII format.
   //! \param[in] vsol Solution vector
-  //! \param fname The filename to write to
+  //! \param[in] fname Name of vector field
   //! \param os Output stream to write the solution data to
   //! \param[in] precision Number of digits after the decimal point
   bool dumpVector(const Vector& vsol, const char* fname,