~~CLOSETOC~~ {{TOC:wide}} \\ ====== Standard Report ====== A web-ready report of the analysis results may be generated using the **[Report]** button on the View tab: {{:wiki:sns:sns2014:s05.png?600|}} Scan&Solve will prompt for a destination, generate the report, and open your web browser to view the output. ====== Customizing Report ====== Scan&Solve uses template files to construct the web-ready reports when the **[Report]** button is clicked in the View tab. These template files, located in the installation directory, are read by Scan&Solve and the output files are generated based on the contents of the templates. The templates use a simple format that may be easily modified to suit a particular end user application. The only tool required is Microsoft’s Notepad or a similar text editor. ===== Template File Format ===== One of two different templates is used depending on the current view setting. Advanced view uses **AdvancedReportTemplate.html**, the simplified view uses **SimplifiedReportTemplate.html**. The content of these files looks something like the following (Color and Descriptions added): {{:wiki:sns:sns2014:s06.png?400|}} The Report Section, where modifications may be made, contains a mixture of HTML code and Scan&Solve keywords. The standard HTML code is demarcated by %%text%% where the format_code controls how the text between the demarcations will be formatted in the output report. HTML code is ignored by Scan&Solve and passed to the output unchanged. Thus, the HTML formatting and content can be changed to suit a particular application, including additional text or images. More information on HTML formatting may be found on the web. The Scan&Solve output is generated by the lines containing a //##KEYWORD// followed, in most cases, by a series of parameters. The keywords, their parameters, and their results in the output are as follows: ^Keyword^Parameters| |//##SCREENSHOT//|With no trailing parameters includes in the report an image from the active Rhino viewport| |::: |//BCS// includes an image of the geometry plus the applied boundary conditions| |::: |//SOLUTION// includes an image of analysis results| |::: |The solution quantity to be displayed is specified by a trailing valid component tag (see below)| |//##PROPERTYTABLE//|//GEOMETRY// includes a table of basic information about the geometry| |::: |//MATERIAL// includes a table of the properties of the material currently in use| |::: |//LOADS// includes a summary table of the applied loads| |::: |//RESTRAINTS// includes a summary table of the applied restraints| |::: |//ANALYSISSETTINGS// includes a table of the current analysis settings| |::: |//EXTREMA// includes the maximum and minimum values of the analysis results as specified by a valid component tag (see below)| |//##EXTREMATABLE//|Includes the maximum and minimum values of the analysis results as specified by a sequence of valid component tags (see below)| |##DATETIME|//DATE// includes the current date in the report, may be followed by //TIME//| |::: |//TIME// includes the current time in the report, may be followed by //DATE//| ===== Component Tags ===== The reporting system in Scan&Solve recognizes the following component tags, mapping them to solution quantities for inclusion in the report. * //DSPX// --x component of the computed displacement field * //DSPY// --y component * //DSPZ// --z component * //DSPT// --total displacement * //VONM// --von Mises stress * //SIG1// --maximum principal stress * //SIG2// --middle principal stress * //SIG3// --minimum principal stress * //EPS1// --maximum principal strain * //EPS2// --middle principal strain * //EPS3// --minimum principal strain * //DGRL// --material’s default danger level * //SED// --strain energy density * //PTC// --principal tension/compression * //EPSXX// --strain XX * //EPSXY// --shear strain XY * //EPSXZ// --shear strain XZ * //EPSYX// --shear strain YX * //EPSYY// --strain YY * //EPSYZ// --shear strain YZ * //EPSZX// --shear strain ZX * //EPSZY// --shear strain ZY * //EPSZZ// --strain ZZ * //SIGXX// --stress XX * //SIGXY// --shear stress XY * //SIGXZ// --shear stress XZ * //SIGYX// --shear stress YX * //SIGYY// --stress YY * //SIGYZ// --shear stress YZ * //SIGZX// --shear stress ZX * //SIGZY// --shear stress ZY * //SIGZZ// --stress ZZ * //DGRVM// --danger level using von Mises criterion * //DGRSS// --danger level using maximum shear stress criterion * //DGRRK// --danger level using Rankine criterion * //DGRCM// --danger level using Coulomb Mohr * //DGRMM// --danger level using modified Mohr ===== Editing the Templates ===== Before editing a report template, make a backup copy in case of errors or problems. Edit the desired template as follows: - Start Notepad and choose File>Open... - In the File Open dialog, browse to the installation directory and locate the file entitled AdvancedReportTemplate.html or SimplifiedReportTemplate.html, as desired. On Windows XP, the default location will be C:\Program Files\Scan&Solve\ AdvancedReportTemplate.html or C:\Program Files\Scan&Solve\ SimplifiedReportTemplate.html. - Open the file. - Decide the type of information and its desired location in the report: - To add an image showing the geometry alone, add the following to the template file: //##SCREENSHOT// - To add an image of the boundary conditions, add the following to the template file: //##SCREENSHOT BCS// - To add an image showing a component of the solution displayed on the geometry, refer to the table of keywords above for valid entries for component_tag and add the following line to the template file: //##SCREENSHOT SOLUTION component_tag// - To add a table of geometric properties, add the following line to the template file: //##PROPERTYTABLE GEOMETRY// - To add a table of material properties, add the following line to the template file: //##PROPERTYTABLE MATERIAL// - To add a table of applied loads, add the following line to the template file: //##PROPERTYTABLE LOADS// - To add a table of restraints, add the following line to the template file: //##PROPERTYTABLE RESTRAINTS// - To add a table of analysis settings, add the following line to the template file: //##PROPERTYTABLE ANALYSISSETTINGS// - To add a table showing the extrema of a solution component, refer to the table of keywords above for valid entries for component_tag and add the following line to the template file: //##PROPERTYTABLE EXTREMA component_tag// - To add a table summarizing solution extrema, refer to the table of keywords above for valid entries for component_tag and add the following line to the template file: //##PROPERTYTABLE EXTREMA component_tag1 component_tag2 ... component_tag3// - Headings and descriptions may be intermixed with the Scan&Solve codes to add comments and headings as desired in the final report. - When finished, save the template file in the installation directory. ===== Examples ===== These two examples depict the output arising from sequences of template code. Refer to the previous section for more details on the specific keywords and their parameters. ==== Detail 1 ==== {{:wiki:sns:sns2014:s07.png?600|}} Template code on the left gives rise to the output on the right. HTML code is output directly to the report file unchanged. Scan&Solve code is interpreted by the Scan&Solve plugin to produce the output shown on the right. This example introduces the use of the //##SCREENSHOT// keyword and the generation of a table using the //##PROPERTYTABLE// keyword. ==== Detail 2 ==== {{:wiki:sns:sns2014:s08.png?600|}} Template code on the left gives rise to the output on the right. HTML code is output directly to the report file unchanged. Scan&Solve code is interpreted by the Scan&Solve plugin to produce the output shown on the right. This example shows an expanded use of the //##SCREENSHOT// keyword to display a solution value. The //##PROPERTYTABLE// keyword is used to generate a summary of a solution component using the //EXTREMA// parameter and a solution component tag, //TDSP//, for total displacement.