Coustyx (R) Version 3.01
Copyright (c) 2014 Advanced Numerical Solutions (Ansol) LLC.
All rights reserved.


README.txt

The following topics are covered here:
A. Details of the files provided in the zip folder
B. How to run the Demo Model?


A. Zip folder
----------------

This zip file contains the following files:
1. readme.txt
2. Coustyx Model File, *.cyx
3. dataset_description.pdf 

Unzip these files from the zip folder to run the Demo Model.

*** Coustyx Model File, *.cyx ***

The *.cyx file is the Coustyx model file. It contains all the information about 
the mesh, the type of model, and acoustics analysis details. 

*** dataset_description.pdf ***

This document contains details about the Demo model.



B. How to run the Demo Model?
-----------------------------

To start running the Demo Model, you need to first download and install Coustyx. 
Visit http://www.ansol.com/ to get a trial version of the software.

A quick set of instructions is provided below to open the Demo Model, view the 
mesh, run the analysis, and visualize the results. 

More information can be obtained at any time from the Help menu or by pressing 
F1 in Prefyx.


*** Open the Demo Model ***

To open a DemoModel:
  1. Open Coustyx from the start menu after the installation is complete.
  2. Open the model file '*.cyx' from the File menu in Coustyx to 
     view the model and run acoustic analysis at specified frequencies.
  3. Expand 'Model' to explore more details about the model.


*** View the mesh ***

We follow different sets of instructions based on the type of the model. The 
type of the Demo Model can be found from the top most member 'Type' in the Model 
tree. It can be any one of the following two: 

  - MultiDomain Model
  - Indirect Model.

To view the Boundary Element (BE) mesh of the Demo Model in the GUI: 

  ** MultiDomain Model **

  View the entire model by right-clicking on Model and choosing Open. Individual
  BE meshes can be found in the Model tree member 'Direct BE Meshes'. To view a mesh,
  right click on the mesh and select Open. Various GUI operations can be
  performed on the mesh opened like this.

  ** Indirect Model **

  If the Type of the Demo Model is Indirect, then the mesh can be viewed by 
  right clicking on the Model tree member 'Indirect BE Mesh' and selecting Open. 
  Various GUI operations can be performed on the mesh opened like this.


*** Run Analysis ***

'Analysis Sequences' is a Model tree member, which is used to set the acoustics 
analysis parameters and is run to obtain steady state sound fields. 

  - To start running the analysis, right click on any analysis sequence and 
    select 'Run'.
  - To edit or verify the analysis parameters, right click on any analysis 
    sequence and select 'Edit'. This opens 'analysis edit dialog box'.
    

Three different analysis sequences are provided in the Demo Model. 

  1. Run Demo: This analysis sequence is a standard sequence, which generates 
     results files that include 'iglass.cgl' data files. Iglass data files 
     are used to visualize the results. After the analysis sequence is run, 
     double-click on the generated 'iglass.cgl' to see the results.
     The generated iglass.cgl file can be found in the same folder as the 
     *.cyx file. You can use the analysis edit dialog box to edit the
     parameters.

  2. Run Validation - FMM: This analysis sequence is custom scripted to 
     generate Transmission Loss results (TL.txt file) computed from Coustyx.
     Fast Multipole Method (FMM) is used in this case. The analysis edit 
     dialog box can't be used to directly modify this sequence. 
     It can be modified only through the Script. 

  3. Run Validation - NonFMM: This analysis sequence is custom
     scripted to generate Transmission Loss results (TL.txt file)
     computed from Coustyx's NonFMM solution (where the system matrices
     are computed). The analysis edit dialog box can't used to directly
     modify this sequence. It can be modified only through the Script.


*** Results ***

Running this Demo Model will generate the following results files.

  ** Iglass.cgl **

  1. This output file is generated when analysis sequence 'Run Demo' is run. 
  2. To open, double-click on the file. 
  3. Browse through the tabs on the top left of the iglass window and select 
     'Attribs'. 
  4. Select any of the acoustic variables listed in the drop-down menu in 
     Attribute to visualize results.

  ** TL.txt **

  This ASCII text file contains Transmission Loss predictions from Coustyx.
  The 1st columns represents frequency and the second TL.


Note: The 'trial license' provided along with the Demo Model is valid for this 
model only. Any changes to the model will invalidate the license. However, the
user is free to modify parameters in analysis sequences to test the software.
