Added documentation

Author: Teseo Schneider

polyfempy/Settings.py

@@ -2,6 +2,7 @@
 
 
 class Settings:
+	"""Class that encodes the settings of the solver, it nodels the input json file"""
 	def __init__(self):
 		self.discr_order = 1
 		self.pressure_discr_order = 1
@@ -34,35 +35,43 @@ def __init__(self):
 
 
 	def set_problem(self, problem):
+		"""Sets the problem, use any of the problems in Problems"""
 		self.problem = problem.name()
 		self.problem_params = problem.params()
 
 
 	def set_material_params(self, name, value):
+		"""set the material parameters, for instance set_material_params("E", 200) sets the Young's modulus E to 200"""
 		self.params[name] = value
 
 
 	def set_vtu_export_path(self, path, bounda_only=False):
+		"""Sets the path to export a vtu file with the results, use bounda_only to export only one layer of the mesh in 3d"""
 		self.export["vis_mesh"] = path
 		self.export["vis_boundary_only"] = bounda_only
 
 
 	def set_wireframe_export_path(self, path):
+		"""Sets the path to export a wireframe of the mesh"""
 		self.export["wire_mesh"] = path
 
 
 	def set_isolines_export_path(self, path):
+		"""Sets the path to export the isolines of the solution"""
 		self.export["iso_mesh"] = path
 
 
 	def set_solution_export_path(self, path):
+		"""Sets the path to save the solution"""
 		self.export["solution"] = path
 
 
 	def set_advanced_option(self, key, value):
+		"""Used to set any advanced option not present in this class, for instance set_advanced_option("use_spline",True), see https://polyfem.github.io/documentation/ for full list"""
 		self.advanced_options[key] = value
 
 	def __str__(self):
+		"""stringygied json description of this class, used to run the solver"""
 		tmp = dict(
 			(key, value)
 			for (key, value) in self.__dict__.items())
@@ -72,4 +81,5 @@ def __str__(self):
 		return json.dumps(tmp, sort_keys=True, indent=4)
 
 	def serialize(self):
+		"""stringygied json description of this class, used to run the solver"""
 		return str(self)