better documentation

Author: Teseo Schneider

polyfempy/Problems.py

@@ -3,6 +3,8 @@
 #################################################
 ############Scalar###############################
 class Franke:
+	"""Franke problem with exact solution https://polyfem.github.io/documentation/#franke"""
+
 	def name(self):
 		return "Franke"
 
@@ -11,18 +13,24 @@ def params(self):
 
 
 class GenericScalar:
+	"""Generic scalar problem https://polyfem.github.io/documentation/#genericscalar"""
+
 	def __init__(self):
 		self.rhs = 0
 		self.dirichlet_boundary = []
 		self.neumann_boundary = []
 
 	def add_dirichlet_value(self, id, value):
+		"""add the Dirichlet value value for the sideset id"""
+
 		tmp = {}
 		tmp["id"] = id
 		tmp["value"] = value
 		self.dirichlet_boundary.append(tmp)
 
 	def add_neumann_value(self, id, value):
+		"""add the Neumann value value for the sideset id"""
+
 		tmp = {}
 		tmp["id"] = id
 		tmp["value"] = value
@@ -38,6 +46,8 @@ def params(self):
 #################################################
 ############Elasticity###########################
 class Gravity:
+	"""time dependent gravity problem https://polyfem.github.io/documentation/#gravity"""
+
 	def name(self):
 		return "Gravity"
 
@@ -46,6 +56,8 @@ def params(self):
 
 
 class Torsion:
+	"""3D torsion problem, specify which sideset to fix (fixed_boundary) and which one turns turning_boundary https://polyfem.github.io/documentation/#torsionelastic"""
+
 	def __init__(self):
 		self.axis_coordiante = 2
 		self.n_turns = 0.5
@@ -62,12 +74,15 @@ def params(self):
 
 
 class GenericTensor:
+	"""Generic tensor problem https://polyfem.github.io/documentation/#generictensor"""
+
 	def __init__(self):
 		self.rhs = [0, 0, 0]
 		self.dirichlet_boundary = []
 		self.neumann_boundary = []
 
 	def add_dirichlet_value(self, id, value, is_dirichlet_dim=None):
+		"""add the Dirichlet value value for the sideset id. Note the value must be a vector in 2D or 3D depending on the problem. is_dirichlet_dim is a vector of boolean specifying which dimentions are fixed."""
 		assert(len(value) == 3)
 		tmp = {}
 		tmp["id"] = id
@@ -79,6 +94,8 @@ def add_dirichlet_value(self, id, value, is_dirichlet_dim=None):
 		self.dirichlet_boundary.append(tmp)
 
 	def add_neumann_value(self, id, value):
+		"""add the Neumann value value for the sideset id. Note the value must be a vector in 2D or 3D depending on the problem"""
+
 		tmp = {}
 		tmp["id"] = id
 		tmp["value"] = value
@@ -94,6 +111,8 @@ def params(self):
 #################################################
 ############Stokes###############################
 class Flow:
+	"""Inflow/outflow problem for fluids. You can specify the sideset for the moving fluxes and the list of obstacle sidesets. https://polyfem.github.io/documentation/#flow"""
+
 	def __init__(self):
 		self.inflow = 1
 		self.outflow = 3
@@ -109,6 +128,8 @@ def params(self):
 
 
 class DrivenCavity:
+	"""Classical driven cavity problem in fluid simulation"""
+
 	def name(self):
 		return "DrivenCavity"
 

polyfempy/Settings.py

@@ -3,6 +3,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
@@ -36,42 +37,50 @@ 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"""
+		"""set the material parameters, for instance set_material_params("E", 200) sets the Young's modulus E to 200. See https://polyfem.github.io/documentation/#formulations for full list"""
+
 		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())
@@ -82,4 +91,5 @@ def __str__(self):
 
 	def serialize(self):
 		"""stringygied json description of this class, used to run the solver"""
+
 		return str(self)