Changeset 14 for mso/template/flowsheet_eqs.mso

Timestamp:

Aug 26, 2006, 5:15:39 PM (17 years ago)

Author:

Rafael de Pelegrini Soares

Message:

Updated the model templates

File:

• mso/template/flowsheet_eqs.mso (modified) (1 diff)

mso/template/flowsheet_eqs.mso

@@ -1 +1 @@
 #*
- * Arquivo modelo para a drescição de um FlowSheet baseado em equações.
+ * EMSO template file for new equation flowsheets.
  *
- * Adicione seus comentários e modifique este arquivo para
- * obter seu novo FlowSheet baseado em equações.
+ * The user should edit the contents of this file in order
+ * to develop a new flowsheet.
  *
- * Autor : 
- * Versão: 
- *
+ * $Id$
  *#
 
 
+#*
+ * The using command makes available entities declared in another files.
+ *
+ * With this command the user can make use of the EML types
+ *#
+using "types";
+ 
+#*
+ * A new model is declared with the Model keyword and a name.
+ * A model can have several sections presented above:
+ *#
+FlowSheet CustomFlowSheet
 
-using "EMSOTypes";
-#*
- * O comando using, faz com que identificadores declarados em arquivos
- * externos sejam reconhecidos.
- * Com o comando using "EMSOTypes" tornam-se disponíveis os tipos padrão
- * do sistema, gravados no arquivo "EMSOTypes.mso".
- * Modelos podem também ser descritos em arquivos em separado e então
- * disponibilizados com o comando using.
- *
- *#
+        #*
+         * In the PARAMETERS section we can define the constants of the
+         * model.
+         * A parameter will never be the result of the simulation its value
+         * need to be specified by the user.
+         *#
+        PARAMETERS
+        V as volume(Brief="The model volume");
+        A as area(Brief="Cross section area");
 
-FlowSheet CustomEquationBasedFlowSheet
+        #*
+         * In the VARIABLE section we declare the variables of the model.
+         * The values of the variables will be calculated by the system
+         * in order to respect the model equations.
+         *#
+        VARIABLES
+        h as length(Brief="The level");
+        
+        #*
+         * In the EQUATIONS section we declare equality expressions involving
+         * the any previously declared parameter or variable.
+         * The equations will be used to determine the value of the variables.
+         *#
+        EQUATIONS
+        A * h = V;
 
-        PARAMETERS
         #*
-         * Dentro da seção de parametros são declarados os parâmetros.
-         * Cada parâmetro é baseado em um tipo normalmente já declarado no
-         * arquivo "stdtypes.mso".
-         * Por exemplo:
-         * Parametro1 as Real(Brief="Primeiro Parametro", Default = 0, Lower = -100, Upper = 1e3);
-         * Declara um parâmetro chamado Parametro1, baseado no tipo Real com modificações na
-         * descrição breve, valor por omissão e limites do parâmetro.
-         *
+         * Additionally, in the case of dynamic models we can declare initial
+         * conditions exactly as in the EQUATIONS section.
+         * Equations declared on the INITIAL section will be used to determine
+         * the initial condition of dynamic models.
          *#
-
-        VARIABLES
-        #*
-         * Na seção de variáveis são delcaradas as variáveis, de forma
-         * análoga aos parâmetros.
-         * Por exemplo:
-         * V as Volume(Brief="Volume do atual do reator");
-         * Declara uma variável chamada V, baseada no tipo Volume com a descrição dada.
-         * F as FlowRate(Brief="Alimentação");
-         * Declara uma variável chamada F.
-         *
-         *#
-
-        EQUATIONS
-        #*
-         * Na seção de equações são declaradas equações de igualdade, normalmente
-         * são os fenômenos físicos e restrições que regem o comportamento do
-         * equipamento que se está modelando.
-         * Por exemplo:
-         * "Balanço Global" diff(M) = F - (V + L);
-         * Declara uma equação chamada "Balanço Global" com a expressão matemática dada.
-         *
-         *#
-
         INITIAL
-        #*
-         * Seção de declaração de condições iniciais (sistemas dinâmicos).
-         * O número de condições iniciais deve ser igual ao número de graus
-         * de liberdade dinâmicos do sistema.
-         * Cada condição inicial é especificada na forma de equação de igualdade.
-         * Exemplos:
-         * "Massa inicial" Mtotal = 60 * "kg";
-         * "Estado estacionário" diff(Mtotal) = 0;
-         *
-         *#
-
-        SET
-        #*
-         * Nesta seção devem fixados todos os parâmetros do FlowSheet, isto
-         * inclui os parâmetros declarados no próprio FlowSheet e aqueles
-         * pertencentes aos Device's.
-         * Exemplos:
-         * length = 10 * "m";
-         * heater.area = 100 * "m^2";
-         *
-         *#
 end