Commit 2c055598 authored by Steffen Schotthöfer's avatar Steffen Schotthöfer
Browse files

more documentation

parent 89068dc9
Pipeline #138057 canceled with stage
......@@ -35,13 +35,13 @@ class Checkerboard_PN : public ProblemBase
bool isAbsorption( const Vector& pos ) const; /*!< @return True if pos is in absorption region, False otherwise */
bool isSource( const Vector& pos ) const; /*!< @return True if pos is in source region, False otherwise */
/**
/*!
* @brief Gets the global index for given order l of Legendre polynomials and given
* order k of Legendre functions.
* Note: This is code doubling from PNSolver::GlobalIndex
* @param l : order of Legendre polynomial
* @param k : order of Legendre function
* @returns global index
* @param l order of Legendre polynomial
* @param k order of Legendre function
* @returns globalIndex
*/
int GlobalIndex( int l, int k ) const;
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment