From fbb967937256b442692e35a4c90841fe3e5e1d93 Mon Sep 17 00:00:00 2001
From: ccolin <cyril.colin@etu.univ-amu.fr>
Date: Sat, 19 Feb 2022 00:41:51 +0100
Subject: [PATCH] document the aspect ratio filter

---
 src/aspect_ratio_filter.h | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/src/aspect_ratio_filter.h b/src/aspect_ratio_filter.h
index e0d2f41..66940cc 100644
--- a/src/aspect_ratio_filter.h
+++ b/src/aspect_ratio_filter.h
@@ -6,6 +6,12 @@
 #include <vtkIdList.h>
 
 
+/*
+  Computes the worst triangle aspect ratio for each cell and stores it
+  in a "aspect_ratio", 1 float cell data array. Requires the input to
+  have an "angles", 12 float cell data array containing the angles of
+  every triangle for each cell, grouped by triangle.
+*/
 class AspectRatioFilter : public vtkUnstructuredGridAlgorithm {
 public:
 	static AspectRatioFilter *New();