Coustyx (R) Version 1.1
Copyright (c) 2007 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 folder contains the following files:
1. readme.txt
2. Coustyx Model File: HemisphereRigidBaffleDemoModel.cyx
3. dataset_description.pdf 
4. process_coustyx_data.py
5. directivity.py

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. This file is opened 
from Prefyx (the GUI for Coustyx).

*** dataset_description.pdf ***

This document contains details about the Demo model and the validation results.

*** process_coustyx_data.py ***

This is a python module has functions to import the pressure and velocity
data generated by Coustyx at the sensor locations, and the power data.
The data are read in to python as numpy arrays using functions read_sensor_file
and read_power_file. After import, the data can be plotted in any desired
manner using matplotlib library. The following files are generated when the
analysis sequences are run.

  Run Demo:
    iglass_demo.cgl              ==> IGlass post processing file
    power_analytical_demo.dat    ==> Power data from Analytical solution.
    power_demo.dat               ==> Power data from Coustyx BEM
    results_demo.dat             ==> Restart file containing surface solution
    sensors_analytical_demo.dat  ==> Pressure, Vx, Vy, Vz data the sensors from analytical solution.
    sensors_demo.dat             ==> Pressure, Vx, Vy, Vz data the sensors from Coustyx BEM            

  Run Validation - FMM:
    iglass_validation_fmm.cgl              ==> IGlass post processing file
    power_analytical_validation_fmm.dat    ==> Power data from Analytical solution.
    power_validation_fmm.dat               ==> Power data from Coustyx BEM
    results_validation_fmm.dat             ==> Restart file containing surface solution
    sensors1_validation_fmm.dat            ==> Pressure, Vx, Vy, Vz data the sensors from analytical solution.
    sensors_analytical_validation_fmm.dat  ==> Pressure, Vx, Vy, Vz data the sensors from Coustyx BEM          

  Run Validation - NonFMM:
    iglass_validation_no_fmm.cgl              ==> IGlass post processing file
    power_analytical_validation_no_fmm.dat    ==> Power data from Analytical solution.
    power_validation_no_fmm.dat               ==> Power data from Coustyx BEM
    results_validation_no_fmm.dat             ==> Restart file containing surface solution
    sensors_analytical_validation_no_fmm.dat  ==> Pressure, Vx, Vy, Vz data the sensors from analytical solution.
    sensors_validation_no_fmm.dat             ==> Pressure, Vx, Vy, Vz data the sensors from Coustyx BEM          

From these runs the sensor data can be imported into Python as numpy arrays
as follows:

  frequencies,pressure,vx,vy,vz = read_sensor_file(r'sensors_validation_no_fmm.dat')

Power data can be imported as follows:
  frequencies, radiated_power, reactive_power, input_power, radiation_efficiency = read_power_file(r'power_validation_no_fmm.dat')


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 Prefyx (the GUI for Coustyx) from the start menu after the 
     installation is complete.
  2. Open the model file '*.cyx' from the File menu in Prefyx 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 **

  If the Type of the Demo Model is MultiDomain, then the Model tree member 
  'Direct BE Meshes' consists of the list of BE meshes. To view a mesh in the 
  GUI, 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: A custom sequence that runs BEM analysis (non FMM) at 1000
     Hz.  Results from Coustyx and the analytical solution, including the
     IGlass visualization file 'iglass_demo.cgl' are generated. Double
     click on the IGlass file to view the results.

  2. Run Validation - FMM: Same as #1. Coustyx's Fast Multipole Method
     (FMM) is used to generate the results.  Frequency range of 500 Hz - 20
     KHz in steps of 500 Hz is considered.  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: Coustyx BEM is used to generate the results.
     Frequency range of 500 Hz - 20 KHz in steps of 500 Hz is considered.
     The analysis edit dialog box can't be used to directly modify this
     sequence.  It can be modified only through the Script. 

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.
