Difference between revisions of "Presets/domain.xml"

From AQUAgpusph
Jump to: navigation, search
m (Fixed wrong file name)
m (Added variables and tools)
Line 1: Line 1:
 
== Introduction ==
 
== Introduction ==
  
domain.xml is a preset used to define a computational domain, such that all the particles (fluids and boundaries are considered) outside such domain will be transformed in fixed particles with null mass.
+
domain.xml is a preset used to define a computational domain, such that all the (fluid/boundary) particles outside such domain will be transformed in fixed particles with null mass, and their positions will be clamped.
 +
 
 +
The main purpose of this tool is controlling singular particles which may scape from the confinement, causing the program failure (due to the constant increase of the grid size).
  
 
== Usage ==
 
== Usage ==
Line 21: Line 23:
 
</Variables>
 
</Variables>
 
</syntaxhighlight>
 
</syntaxhighlight>
 +
 +
This preset should be loaded after [[Presets/cfd.xml|cfd.xml]].
 +
 +
== Variables defined ==
 +
 +
When this preset is loaded some variables are generated (on top of the [[Variables|default variables of AQUAgpusph]]):
 +
 +
{| class="wikitable" style="text-align: left; width: 800px;"
 +
| NAME
 +
| TYPE
 +
| LENGTH
 +
| DESCRIPTION
 +
|-
 +
| domain_min
 +
| vec
 +
| 1
 +
| First corner of the computational domain.
 +
|-
 +
| domain_max
 +
| vec
 +
| 1
 +
| Second corner of the computational domain.
 +
|}
 +
 +
It is intended that <code>domain_max > domain_min</code> (for all the components).
 +
 +
== Tools ==
 +
 +
The following tools are set to be executed each time step, just before the [[Presets/cfd.xml#Tools|FixedTimeStep tool]]. (see [[Tools|Tools]] and [[Presets/cfd.xml|cfd.xml]] to learn more about this):
 +
 +
{| class="wikitable" style="text-align: left; width: 800px;"
 +
| NAME
 +
| TYPE
 +
| DESCRIPTION
 +
|-
 +
| Domain
 +
| [[Tools#kernel|kernel]]
 +
| Look for the particles outside the computational domain, and "destroy" them (see [[Introduction|the introduction]]).
 +
|}
  
 
[[Category:Presets]]
 
[[Category:Presets]]
 
[[Category:Variables]]
 
[[Category:Variables]]
 
[[Category:Tools]]
 
[[Category:Tools]]

Revision as of 11:29, 2 April 2015

Introduction

domain.xml is a preset used to define a computational domain, such that all the (fluid/boundary) particles outside such domain will be transformed in fixed particles with null mass, and their positions will be clamped.

The main purpose of this tool is controlling singular particles which may scape from the confinement, causing the program failure (due to the constant increase of the grid size).

Usage

To use it the following tag should be added to include the preset:

<Include file="/usr/share/aquagpusph/resources/Presets/domain.xml" />

Where /usr/share/aquagpusph/ should be conveniently modified.

After that, the domain should be defined setting the associated variables. For instance (extracted from the Standing Wave example):

<Variables>
    <Variable name="domain_min" type="vec" value="-0.4, -0.21" />
    <Variable name="domain_max" type="vec" value="2.4, 1.26" />
</Variables>

This preset should be loaded after cfd.xml.

Variables defined

When this preset is loaded some variables are generated (on top of the default variables of AQUAgpusph):

NAME TYPE LENGTH DESCRIPTION
domain_min vec 1 First corner of the computational domain.
domain_max vec 1 Second corner of the computational domain.

It is intended that domain_max > domain_min (for all the components).

Tools

The following tools are set to be executed each time step, just before the FixedTimeStep tool. (see Tools and cfd.xml to learn more about this):

NAME TYPE DESCRIPTION
Domain kernel Look for the particles outside the computational domain, and "destroy" them (see the introduction).