Adding docstring. Updating method name

This commit is contained in:
Patrick Shriwise 2023-03-04 23:57:55 -06:00
parent 5946763323
commit b02e558fae
2 changed files with 7 additions and 7 deletions

View file

@ -76,7 +76,7 @@ public:
// Methods
//! Update a position to the local coordinates of the mesh
virtual void to_local_coords(Position& r) const {};
virtual void local_coords(Position& r) const {};
//! Return a position in the local coordinates of the mesh
virtual Position local_coords(const Position& r) const { return r; };
@ -257,7 +257,7 @@ public:
PeriodicStructuredMesh() = default;
PeriodicStructuredMesh(pugi::xml_node node) : StructuredMesh {node} {};
void to_local_coords(Position& r) const override { r -= origin_; };
void local_coords(Position& r) const override { r -= origin_; };
Position local_coords(const Position& r) const override
{
@ -265,7 +265,7 @@ public:
};
// Data members
Position origin_ {0.0, 0.0, 0.0};
Position origin_ {0.0, 0.0, 0.0}; //!< Origin of the mesh
};
//==============================================================================