Model/include/documentation.h

   1 /** \page page_model PlaQui Model
   2
   3 \section page_model_general Descripción General.
   4         El modelo es quien se encarga de la simulación de una planta química dentro
   5         de este conjunto de herramientas. Puede ser utilizado como un programa independiente
   6         (<tt>plaqui-model</tt>) o como una biblioteca estática y ser compilado dentro de un
   7         ejecutable como lo hace PlaQui Server.
   8
   9         \subsection page_model_general_clases Clases del Modelo.
  10                 Para cada elemento que es posible simular, el modelo tiene una clase que se encarga
  11                 de ello. También existe una clase PlaQui::Model::Simulator que es quien se encarga
  12                 de manejar una simulación, cargar una planta desde un archivo XML y da una interfaz
  13                 para poder acceder a propiedades del modelo desde el exterior.
  14
  15                 A continuación se puede observar un diagrama de clases del modelo:
  16                 \image html clases.png
  17                 \image latex clases.eps "Diagrama de clases." width=14cm
  18
  19         \subsection page_model_general_simulacion Simulación.
  20                 Para entender qué es lo que vemos al simular una planta, primero debemos entender
  21                 cómo es que el modelo resuelve la simulación.
  22
  23                 En cada paso de la simulación se realizan 3 tareas por separado, que deben ser ejecutadas
  24                 de forma correcta, ya que la alteración del orden puede provocar resultados inesperados. El
  25                 primer paso es el de actualización (<em>update</em>), luego el de simulación
  26                 (<em>simulate</em>) y por último la actualización de colores.
  27
  28                 \subsection page_model_update Update.
  29                         El objetivo de esta fase es que todos los elementos del modelo calculen el flujo que va a
  30                         circular por ellos en la iteración actual. Para poder hacer esto, siempre se debe llamar
  31                         al \ref PlaQui::Model::Pump::update "update" de las bombas únicamente, ya que desde ellas
  32                         sale el fluido.
  33
  34                         La bomba envía un mensaje a su salida, consultando por el flujo máximo que el elemento al
  35                         que está conectado es capaz de manejar, informandole también cual es la capacidad de envío
  36                         de flujo propio.
  37
  38                         Este primer envío da como resultado una <em>reacción en cadena</em> hasta llegar a los
  39                         drenajes que tenga el circuito. Cada elemento reacciona de manera distinta y reacciona
  40                         en base a sus requerimientos.
  41
  42                         Cuando la bomba recibe una respuesta de flujo máximo saliente menor a su capacidad, ésta
  43                         se queda con la menor de ambas. Esto es debido a que el conducto no puede soportar más
  44                         de lo que responde, y el restante que la bomba pueda entregar <em>rebotaría</em> y debería
  45                         elevar la presión dentro de la bomba hasta explotar. Tambíen aparecerían turbulencias
  46                         que harían que el flujo sea fluctuante. Sin embargo, como estos parámetros no son tomados
  47                         en cuenta, el resultado de la simulación es que la bomba se <em>limita</em> a enviar sólo
  48                         lo que la salida pueda aceptar, pareciendo que se <em>auto regula</em>.
  49
  50                         La consecuencia de lo explicado anteriormente es por requerimiento del enunciado y
  51                         simplificacion del modelo debido al poco tiempo con el que se cuentó para el total del
  52                         proyecto.
  53
  54                 \subsection page_model_simulate Simulate.
  55                         Es esta fase, con los flujos actuales a la orden del día, cada objeto se actualiza.
  56                         El tanque se suma el flujo entrante y se resta el flujo saliente.
  57
  58                 \subsection page_model_color Update Color.
  59                         Aquí comienza una cadena de mensajes similar al del update, pero esta vez se envía hacia
  60                         las entradas, y se pide que nos envíe el \ref PlaQui::Model::PlantItem::update_color "color".
  61                         Entonces, por ejemplo, una union pide un color a cada salida y luego los suma.
  62
  63
  64
  65 */
  66
  67 /** \namespace PlaQui::Model
  68
  69 Infrastructura del modelo de simulación para PlaQui.
  70
  71 Bajo este espacio de nombres (namespace) se encuentran todas las clases para la
  72 simulación de PlaQui.
  73
  74 */
  75