Commit 9fc75b6b authored by frey_m's avatar frey_m
Browse files

FielWriter: update comment

parent 794d517f
......@@ -25,6 +25,14 @@ class FieldWriter
{
public:
/// Dump a scalar or vector field to a file.
/*
* @param[in] field is the scalar or vector field on the grid
* @param[in] name is the field name
* @param[in] unit of the field
* @param[in] step of the output
* @param[in] image of the potential (optional)
*/
template<typename FieldType>
void dumpField(FieldType& field, std::string name,
std::string unit, long long step,
......
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