Skip to content

Commit 72039a8

Browse files
author
Martin D. Weinberg
committed
Add more comments only
1 parent 463f4ae commit 72039a8

1 file changed

Lines changed: 13 additions & 2 deletions

File tree

include/OrthoFunction.H

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -78,16 +78,26 @@ private:
7878

7979
public:
8080

81-
//! Constructor
82-
OrthoFunction(int nmax, DensFunc W, double rmin, double rmax, double scale, int dof);
81+
/** Constructor
82+
@param norder Order of the orthogonal polynomial
83+
@param W Density weight function
84+
@param rmin Inner radial bound
85+
@param rmax Outer radial bound
86+
@param scale Mapping scale
87+
@param dof Degrees of freedom (2 or 3)
88+
*/
89+
OrthoFunction(int norder, DensFunc W, double rmin, double rmax, double scale, int dof);
8390

8491
//! Destructor
8592
virtual ~OrthoFunction() {}
8693

8794
//! Evaluate orthogonal functions at r
95+
//! @param r Radial coordinate
96+
//! @return A vector of the orthogonal functions
8897
Eigen::VectorXd operator()(double r);
8998

9099
//! Reset Legendre knots and weights for inner product
100+
//! @param N Number of Legendre knots
91101
void setKnots(int N)
92102
{
93103
knots = N;
@@ -99,6 +109,7 @@ public:
99109
Eigen::MatrixXd testOrtho();
100110

101111
//! Dump the orthogonal function table
112+
//! @param filename Filename for output
102113
void dumpOrtho(const std::string& filename);
103114
};
104115

0 commit comments

Comments
 (0)