
			     CADKEY ANALYSIS 
			       README FILE

    This README file contains up-to-the-minute information on CADKEY
    ANALYSIS.  Included are options for advanced users and a listing 
    of current known errors.   
  
    Cadkey ANALYSIS included with CADKEY 6 will not run under Windows or 
    OS/2.
   

1.0 EXPLANATION OF 'CADKEY ANALYSIS' CONFIG. FILE "CKACFG.DAT" :
 
    CADKEY ANALYSIS stores the most current analysis configuration in the
    file "CKACFG.DAT" and reads it back into the system on start up. This 
    feature minimizes the redundant input every time the user starts up 
    CADKEY ANALYSIS. The file "CKACFG.DAT" consists of keywords followed 
    by the value of the parameter they represent. The parameters are 
    divided into two groups based on the process available to change their 
    values: 
    There are two processes presently available to change parameters:
    (a) Standard Analysis interface.
    (b) CADKEY calculator and/or edit the file 'CKACFG.DAT'.

    (a) The following parameters can be changed in the FILES and/or CONFIG 
	menu options of CADKEY ANALYSIS. The values of these parameters are
	either the default or set in the previous analysis session.

    <parameter> <value>              <description>
    ----------------------------------------------------------------------
    
    INFILE     2dpart.cdl   Name of input file (last used).
    THERMIN    2dpart-t.ses Name of thermal session file (last used).
    ALPHA      1.23e-05     Thermal coefficient of expansion.
    ACCM       -9.8         Linear Acceleration.
    OMEGA      12           Angular Velocity (RPM).
    PTLOAD     1            Point Load Value.
    LOADEF     1000         Distributed load.
    EMOD       1.4832e+09   Modulus of Elasticity.
    THCON      0.02112      Thermal Conductivity.
    CNU        0.33         Poisson's ratio.

								  
    DENSITY    5.39136      Mass density.
    INITTEMP   0.0          Initial Temperature at which geometry was drawn.
    ATYPE       1           Analysis type.
    INTYPE      1           Input file type.
    DIMENSION  20           Dimensionality.
    UNITSYS    0            Unit system id (last used).
    MATERIAL   0            Material index (last used).
    SFPATH  C:\CADKEY\SF    Temporary file path.
    EXEPATH C:\CADKEY\CKA   Executable file path.
    GEOPATH C:\CADKEY\CDL   Model file path.
    ----------------------------------------------------------------------


    (b) Listed below are parameters along with their corresponding variable
	names that can be changed via CADKEY calculator.  You must be 
	in the CADKEY ANALYSIS interface and should use the corresponding 
	variable name, not the parameter name, to change any parameter. 

	CADKEY calculator is accessed by typing <CTRL> <I>. AT the prompt 
	CALC> type the variable name and the new assigned value.
	Example: CALC> ringsize = 1.5 <RET>.

	The changed values are valid for the current session only unless 
	they are saved by entering the CONFIG menu and cursor selecting the 
	DONE button. These values then are written to the 'CKACFG.DAT' file 
	and will be used in the next session.

	The parameter values can also be edited directly in the 'CKACFG.DAT'
	file using any system editor. 


    <parameter> <sample <variable          <description>
		 value>      name>      
    ------------------------------------------------------------------------
    FRAMES      10      frames      Number of frames used in animation.
    LSCALE      0.0     lscale      Scale factor of first animated slide.

    STANG       0.0     stang       Starting sweep angle for axisymmetric 
				    results.
    ENDANG      10.0    endang      End sweep angle for axisymmetric results.
    NUMINC      5.0     numinc      Angular increment for sweep.

    The following four parameters control the scale factors for text height 
    and width in the RESULTS menu.

    TITLE_HT    1.2     title_ht    Plot 'title text' height.
    TITLE_WT    1.0     title_wt    Plot 'title text' width.
    LEGND_HT    1.1     legnd_ht    Legend text height.
    LEGND_WT    1.1     legnd_wt    Legend text width.

    RINGSIZE    1.0     ringsize    Size of circles used in fastview.

    BANR_HT     1.1     banr_ht     Height of status banner.
    BANR_ASP    1.0     banr_asp    Aspect ratio of status banner.
    BANR_COL    13      banr_col    Color # of status banner.
    BANR_FNT    1       banr_fnt    Font # of status banner.

    BKGD_COL    0       bkgd_col    CADKEY viewport back ground color #.

								   
    The next 14 parameters set the color number corresponding to various 
    range of values in the legend.
    LEGEND_0    8       legend[0]   Color # for 1st range (Lowest).
    LEGEND_1    9       legend[1]   Color # for 2nd range.
    LEGEND_2    5       legend[2]   Color # for 3rd range.
    LEGEND_3    11      legend[3]   Color # for 4th range.
    LEGEND_4    10      legend[4]   Color # for 5th range.
    LEGEND_5    7       legend[5]   Color # for 6th range.
    LEGEND_6    14      legend[6]   Color # for 7th range.
    LEGEND_7    15      legend[7]   Color # for 8th range.
    LEGEND_8    4       legend[8]   Color # for 9th range.
    LEGEND_9    12      legend[9]   Color # for 10th range.
    LEGEND_10   13      legend[10]  Color # for 11th range.
    LEGEND_11   6       legend[11]  Color # for 12th range.
    LEGEND_12   3       legend[12]  Color # for 13th range.
    LEGEND_13   2       legend[13]  Color # for 14th range (Highest).
    ------------------------------------------------------------------------


2.0 SESSION FILE RECONSTRUCTION :

    CADKEY ANALYSIS allows you to keep a record of the analysis session
    in a file called the 'session file'. If the session save option
    is selected in the FILES option, all the analysis information 
    such as geometry, boundary conditions, material properties, and
    results are stored in the specified session file name.  

    The Session file is stored in the 'model directory' and is an ASCII 
    file. You can reconstruct the complete analysis session, in 
    CADKEY ANALYSIS, at a later date by simply changing the 
    'Input Type' in the FILES menu to Session file and typing the session 
    file name. The system will re-create the previous analysis session.  
    The boundary condition symbols appear on the screen and the results 
    are loaded into CADKEY ANALYSIS.

    What is not reconstructed: The shaded/contour plots from the previous 
    session are not retrieved.  These plots, if requested, have to be 
    recomputed again in the session reconstruction thus will take some time.



3.0 FEM MESH OUTPUT :

    CADKEY ANALYSIS lets you output a mesh for the 2-D Finite Element Method
    (FEM) of the geometry being analyzed. The resolution of the FEM mesh 
    generated is based on the resolution of boundary segmentation.

    How to output 'FEM mesh': User must follow the following two steps.
      (a) Select the 'FEM mesh save' option in FILES menu. 
      (b) View at least one shaded/contour result plot in the current session.

    When the above two steps (a) and (b) are followed, CADKEY ANALYSIS 
    creates two files in the model directory. The model directory name is
    specified in the CONFIG menu: 
    File 1 : A CADL file always called 'fem.cdl' containing the domain 
    triangular elements. This file can be viewed in CADKEY by selecting
    the sequence FILES, CADL, EXECUTE, fem <RET>.
    File 2 : An ASCII file containing the node/element listing. The name
    of this file is specified in the FILES menu to the right of the 
								   Page 3
    'FEM mesh save' option. The elements are all six-nodes triangle. 
    You can look at, and edit if need be, this file in the system 
    supported editor.  The format of this file is listed below.

    <# of nodes> <# of elements> <dummy parameter>
    <node index> <x-coord of node> <y-coord of node> <z-coord of node>
    <element index> <list of vertices separated by spaces>



4.0 EQUILIBRIUM ERROR CHECK :

    The analysis program checks for equilibrium after the solver has 
    computed the solution. The percentage lack of equilibrium called 
    'equilibrium error' is an indication of 'goodness' of the analysis
    just finished.  For a poor analysis the equilibrium error will 
    exceed the acceptable limit of the program and an error message 
    will appear on the screen. In CADKEY ANALYSIS this limit is set 
    at 7% (can not be changed.)

    Before suggesting the solution strategy to reduce the equilibrium 
    error, it is to be noted that this release of analysis is not suitable
    for the analysis of very thin or narrow models. Therefore if the model 
    being analyzed has a high length/width ratio then the solution scheme
    suggested below will be of little help.

    Reasons for high equilibrium error:
     (a) Total positive and negative equilibrium values are very small.
     (b) Unconstraint Rigid body rotation (for elastic/thermoelasticity  
	 analysis only).
     (c) Nodes (in some regions) on the boundary are too few to capture the
	 correct response. 

    Solution for:
     Case (a) - 
	  Compare the actual error value with the total positive and 
	  negative equilibrium values. If it can be ascertained that the
	  high percentage error is due to roundoff error then 'continue' 
	  the solution without giving any further consideration. Otherwise 
	  proceed with the suggested solutions for case (b) and case (c).

    Solution for:
     Case (b) - 
	  Constrain at least two nodes in either one or both directions.

    Solution for:
     Case (c) - Follow the following steps:
	  (1) Continue the current analysis session and choose RESULTS, 
	      select any result quantity and FASTVIEW its distribution. 
	  (2) Isolate regions of high activity.
	  (3) Re-run the analysis after decreasing the size of segments 
	      (more segments) in these regions.
	  (4) Look for equilibrium error. It may be now within limit. 
	      Otherwise repeat steps (1) - (4).


5.0 DETAILS ON SAVED PATTERN FILES :
   
    The pattern file created when the display was saved in the RESULT menu
    can be retrieved in CADKEY by following the sequence, FILES, PATTERN, 
    RETRIEV, <pattern file name>, <NO/YES>, <ENT-LEV> ..... Now, all the 
    design, details and drafting features of CADKEY can be used on this 
    file to add, edit or delete any text or graphics entities (viz. label,
    material properties, date, original complete CAD drawing, etc.)

    In all the saved pattern files the entities residing in first three 
    CADKEY levels are explained below. One can just turn the levels off/on 
    as desired for these entities before plotting/printing.

     (a) Level 1 :  Segmented Boundary (elements).
     (b) Level 2 :  Boundary Nodes (three nodes per element).
     (c) Level 3 :  Boundary Condition Symbols (icons).



6.0 USER ACCESSIBLE ANALYSIS PARAMETERS :
    
    Few additional parameters not listed in CKACFG.DAT file but may be of
    interest to users are listed below.

     (1) numnode  : Total number of nodes in the model. 
     (2) ne       : Total number of elements in the model. 
     (3) area     : The net area of the segmented model.
     (4) shellmem : The memory available for analysis. The available memory
		    is read from your CADKEY configuration file 'CONFIG.DAT'
		    and is set as described in chapter 3 of Getting Started
		    Guide under 'setting CADKEY'. 
     (5) reserror : Percent Residual error computed for the solution.
		    Read 4.0 for a detail explanation.
     (6) defscal  : Deflection Scale factor used to display the deflected
		    profile.
		    The deflection profile in elastic/thermoelastic analysis 
		    is scaled (by default), to be visible, for the users. 
		    However in some instances, such as to check for collisions
		    in an assembly, it may be necessary to view and save the 
		    actual deflected shape. A change in this parameter can
		    override the default scale factor in the current session.
		    Users should change this parameter before selecting DEFLECT
		    option in the RESULTS menu.

    The calculator can be used 'only' to inquire the value of (1)-(5) 
    parameters, not to reassign their numeric values. Whereas for the parameter 
    'defscal' reassignment is permissible. The new assigned value remains
    in effect for the current analysis session only. It is changed to the
    default value on exiting the analysis.

    Example for Reassigning the 'defscal' Parameter :
	The following example illustrates the steps to follow to set the 
	parameter 'defscal' to 1.0 (no scaling).  Follow these steps before 
	selecting the DEFLECT option in the RESULTS menu.
	1. Start Calculator:            <CTRL> <I>
	2. Type at the Prompt CALC>:    defscal = 1.0 <RET> 
	3. Stop Calculator:             <RET> 

								  
7.0 RUNNING 'CADKEY ANALYSIS' WITH 'CUTTING EDGE' :
    
    Although CADKEY ANALYSIS is designed to work with CADKEY exclusively,
    it is possible to install and run analysis under CUTTING EDGE.

    In order to install CADKEY ANALYSIS with CUTTING EDGE, the user must
    create a dummy file with the name 'cadkey.exe' in the cutting edge 
    directory. The analysis install program looks for 'cadkey.exe' in 
    order to install analysis. Once installed, the analysis should function 
    exactly same with CUTTING EDGE as with CADKEY.


8.0 ADDING MATERIAL TO THE MATERIAL PROPERTY LIBRARY (MPL) :

    You can add any number of materials to your Analysis program using the
    system editor. Added material will appear in the UNITS & MATERIAL option
    of CONFIG menu on starting CADKEY ANALYSIS.

    How to add new material: Follow steps (a)-(d) as described below.
     (a) Go to your analysis executable directory and copy the file
	 'material.mpl' to a backup file say called 'material.bak'.
	 Example: C:\CADKEY\CKA> copy material.mpl material.bak
     (b) Use any system editor and edit the file 'material.mpl'.
     (c) Look for the keyword #num_mats. Increment the value on the next 
	 line by the number of materials to be added.
	 Example: If the value is 10 and you are adding three more 
		  materials then change 10 to 13.
     (d) Go to the end of the file, 
	 (i)   Create a new line and type the name of the material.
	 (ii)  On the next line type any description of the material.
	 (iii) Type next the material properties, in SI(m) system of units 
	       as described in the UNITS & MATERIAL option of CONFIG menu.
	       Enter the material properties in the sequence listed below.
	       (0) Density  (kg/m^3).
	       (1) Young's Modulus (N/m^2).
	       (2) Poisson's ratio. 
	       (3) Thermal Expansion Coeff. (m/m/deg.C).
	       (4) Ultimate strength, tension (N/m^2).
	       (5) Ultimate Strength, compression (N/m^2). 
	       (6) Yield stress, tension (N/m^2).
	       (7) Thermal conductivity.(Watt/(m*deg.C)).

	 Type 0.0 for the material property not available. Always type 
	 either the true available value or 0.0 for all the material 
	 properties in the specified sequence described in (iii). 

	 CAUTION: The property not available will be assigned a value of 
	 0.0 in CADKEY ANALYSIS if need to be used in analysis.

 
    Suggestions for Advanced Users : Advanced users may wish to maintain
    more than one material library, with one library for each material 
    category. For instance, material properties for all types of steels 
    may be kept in the file 'steels.mpl'. Before creating or using multiple
    material library files, always make a backup of the 'material.mpl' 
    file supplied with the CADKEY ANALYSIS by following step (a) above.

    How to create new material libraries: Follow steps (e)-(g) as described 
    below:
     (e) Copy 'material.mpl' to another name (i.e. 'steels.mpl').
     (f) Modify the new file 'steels.mpl' using the system's editor to 
	 either add or delete materials from the file following the steps (c)
	 and (d) above.
     (g) Copy the new material library file 'steels.mpl' to the file 
	 'material.mpl'. The copy command is executed either before starting
	 CADKEY or through the CADKEY DOS shell (select <CONTROL>, <SYSCMD>, 
	 <SHELL> to get DOS shell within CADKEY, type EXIT to go back to
	 CADKEY after copying the file.)
	 Example: C:\CADKEY\CKA> copy steels.mpl material.mpl


9.0 LIST OF KNOWN ERRORS AT THE TIME OF RELEASE :

     (1) Duplicate or overlapping geometric entities result in serious
	 errors. The error, many times, can not be traced back to the
	 redundant geometry. Recheck the geometry for overlapping entities
	 if you see the message 'Broken loops encountered' or find a negative
	 computed area.
	 
     (2) Interior results for points very close to the boundary results in
	 erroneous values.

     (3) Shaded/contour plot for narrow regions, bounded with very different 
	 boundary segmentation resolution results in system crash.

     (4) Session reconstruction fails for axisymmetric domains with boundary
	 segments at R = 0 (on the Z-axis).

     (5) Thermoelastic session reconstruction does not update the name 
	 of the Thermal session file automatically in the CONFIG menu. Need 
	 to do it manually.
	 
     (6) If the boundary conditions in the ASSIGN menu are not saved but have
	 been changed since the last save, the CADKEY ANALYSIS graphical 
	 display does not restores the previous saved boundary conditions on 
	 exiting ASSIGN. Therefore, it is advised to always save the boundary
	 conditions before exiting ASSIGN.
	 Although SOLVE and RESULTS menus do work correctly and uses only 
	 the last saved boundary conditions.

     (7) Boundary conditions icons can be deleted using CADKEY immediate mode
	 command. Solution: Do not delete icons using <CTRL> <Q>, instead 
	 remove them within ASSIGN. 

     (8) Some display options in the RESULTS menu do not build completely the 
	 'CADKEY history line' of all menu options leading up to the current 
	 menu position.
