class Introduction "Introduction"
extends Modelica.Icons.Information;
annotation (
DocumentationClass = true,
Documentation(info = "<html>\n <p>\n The package <b>HydraulicsByFluidon</b> is a <b>modelica</b> library\n for the one-dimensional simulation of fluid-power systems. The models are\n based on the <b>lumped parameter</b> approach. The library consists of \n various hydraulic components and predefined hydraulic fluids. In order to enable\n the user to create custom components, the library specific component interfaces are\n provided as well.\n </p>\n <p>\n <b><u>Minimal working example</u></b>\n </p>\n <p>\n Each model created by using the HydraulicsByFluidon package requires the <b>Liquid</b>\n and <b>Environment</b> blocks to be added:\n </p>\n <p>\n <center><img src=\"modelica://HydraulicsByFluidon/Resources/Images/UsersGuide/UsersGuideMinimalExample.png\"></center>\n </p>\n <p>\n The environment block provides the simulation with information about the \n <b>environmental conditions</b>, e.g. the ambient pressure or the value of \n the gravitational constant. The liquid block determines the hydraulic fluid \n that is used, which is why <b>every</b> hydraulic component in a model has to be connected to it. In\n order to save the user the trouble of connecting the liquid block to each\n component manually, the option <b>forwardFluidProperties</b> is included in certain\n components. If this option is used, the user has to connect the liquid block to each\n hydraulic circuit only once since the fluid information is forwarded between the components.\n </p>\n <p><b><u>Fundamentals of the lumped parameter approach</u></b></p>\n <p>\n In hydraulic engineering, the lumped parameter approach assumes that the state of a\n cross-section within a hydraulic system is fully described by the (mass) flow rate and the \n pressure. Due to numerical limitations, the application of the lumped parameter approach is\n usually restricted to systems with low to moderate dynamic effects. \n In the lumped parameter approach, there are three fundamental types of hydraulic elements:\n <ul>\n <li>Resistor</li>\n <li>Capacitor</li>\n <li>Inductor</li>\n </ul>\n The resistor represents an <b>ideal loss</b> without any inertia or hydraulic stiffness. Its\n constitutive equation can be expressed as follows:\n </p>\n <p>\n <center><img src=\"modelica://HydraulicsByFluidon/Resources/Images/UsersGuide/EqResistor.gif\"></center>\n </p>\n <p>\n This equation states that the mass flow rate is assumed to be proportional to the n-th power\n of the pressure drop across the component. The exponent can vary between 1 and 0.5, depending\n on the flow regime.\n </p>\n <p>\n By contrast, the capacitor corresponds to an <b>ideal hydraulic spring</b> without any losses or inertia.\n Mathematically, its behaviour is described by the following differential equation:\n </p>\n <p>\n <center><img src=\"modelica://HydraulicsByFluidon/Resources/Images/UsersGuide/EqCapacitor.gif\"></center>\n </p>\n <p>\n According to this model, the temporal change in pressure is proportional to the difference\n in incoming and outgoing mass flows, multiplied with the bulk modulus and divided by the density\n and volume of the fluid in the respective component.\n </p>\n <p>\n The inductor is an <b>ideal inertia</b> without any losses or stiffness. It is mathematically described by the following equation:\n </p>\n <p>\n <center><img align=\"middle\" src=\"modelica://HydraulicsByFluidon/Resources/Images/UsersGuide/EqInductor.gif\"></center>\n </p>\n <p>\n This equation is the hydraulic formulation of Newton's second law of motion. It states that\n the temporal change in mass flow rate is equal to the pressure difference across the component,\n multiplied by the cross-sectional flow area and divided by the length of the component.\n </p>\n <p>\n <b><u>Solution procedure</u></b>\n </p>\n <p>\n These fundamental elements can be used alone or in combination to model actual hydraulic components.\n If components modeled through these elements are connected to a circuit model, they form a\n system of coupled ordinary differential equations which has to be solved numerically. The\n solving algorithm works in a staggered way: based on the initial pressure distribution,\n the resistors and inductors calculate <b>flow rates</b>. These flow rates are then used as boundary\n conditions for the capacitors, which calculate the new <b>pressure distribution</b> in return. After\n this step, the whole procedure is repeated. Due to the algorithm structure outlined above,\n reasonable initial pressures have to be assigned to components that are based on capacitor\n elements, e.g. simple volumes.\n </p>\n <p>\n Instructions regarding the use of individual components can be found in\n the respective component's documentation.\n </p>\n <p>\n <b><u>Component library</u></b>\n </p>\n <p>\n The User's Guides for the Component library can be accessed <a href=\"modelica://HydraulicsByFluidon.UsersGuide.Components\">here</a>.\n </p>\n </html>"));
end Introduction;