Create Linear Dynamic Response Spectrum Study Example (C#)

This example shows how to create a linear dynamic study with a response spectrum analysis and get some study options.

//---------------------------------------------------------------------------
// Preconditions:
// 1. Add the SOLIDWORKS Simulation as an add-in
//    (in SOLIDWORKS, click Tools > Add-ins > SOLIDWORKS Simulation).
// 2. Add the SOLIDWORKS Simulation primary interop assembly as
//    a reference (in the IDE's Project Explorer, right-click
//    the project name, click Add Reference, click the Browse tab,
//    navigate to install_dir\api\redist\CLR2,
//    click SolidWorks.Interop.cosworks.dll, and click OK).
// 3. Ensure that the specified file to open exists.
// 4. Ensure that the c:\temp folder exists.
//
// Postconditions:
// 1. Opens the specified file.
// 2. Creates a linear dynamic study for response spectrum analysis.
// 3. Runs the analysis.
// 4. Prints some study options and results to the Immediate window.
// 5. Saves the solution step, displacement, velocity,
//    and stress result files to c:\temp.
//
// NOTE: Because the model is used elsewhere, do not save any changes.
//---------------------------------------------------------------------------
using Microsoft.VisualBasic;
using System;
using System.Collections;
using System.Collections.Generic;
using System.Data;
using System.Diagnostics;
using SolidWorks.Interop.sldworks;
using SolidWorks.Interop.swconst;
using SolidWorks.Interop.cosworks;
using System.Runtime.InteropServices;
namespace CreateDynRespSpectrumStudy_CSharp.csproj
{
    partial class SolidWorksMacro
    {
 
        public void Main()
        {
            ModelDoc2 Part = default(ModelDoc2);
            CosmosWorks COSMOSWORKS = default(CosmosWorks);
            CwAddincallback CWAddinCallBack = default(CwAddincallback);
            CWModelDoc ActDoc = default(CWModelDoc);
            CWStudyManager StudyMngr = default(CWStudyManager);
            CWStudy Study = default(CWStudy);
            CWShellManager ShellMgr = default(CWShellManager);
            CWMaterial ShellMat = default(CWMaterial);
            CWLoadsAndRestraintsManager LBCMgr = default(CWLoadsAndRestraintsManager);
            CWDynamicStudyOptions DynStudyOptions = default(CWDynamicStudyOptions);
            CWBaseExcitation CWBaseExcitationU = default(CWBaseExcitation);
            object CWBaseExcitationEntity = null;
            object CWDirectionEntity = null;
            int longstatus = 0;
            int longwarnings = 0;
            int errCode = 0;
            bool boolstatus = false;
            int nStep = 0;
            object pDisp5 = null;
            object[] DispArray1 = new object[1];
            object[] DispArray3 = new object[1];
            object[] Disp = null;
            object[] Stress = null;
            object[] Velocity = null;
            object[] Acceleration = null;
            string sStudyName = null;
            CWStudyResultOptions ResultOptions = default(CWStudyResultOptions);
            int i = 0;
            int freqOption = 0;
            double freqValue = 0;
            int bChecked = 0;
            object forces2 = null;
            object selectedAndModelReactionFM = null;
            object selectedOnlyReactionFM = null;
            CWShell CWFeatObj1 = default(CWShell);
            CWRestraint CWFeatObj3 = default(CWRestraint);
            CWMesh CWFeatObj4 = default(CWMesh);
            CWResults CWFeatObj5 = default(CWResults);
            int param = 0;
            double dParam = 0;
 
            //Tolerances and baselines
            const double MeshEleSize = 26.5868077635828; //mm
            const double MeshTol = 1.32934038817914; //mm
 
            //Open document
            Part = swApp.OpenDoc6("C:\\Program Files\\SOLIDWORKS Corp\\SOLIDWORKS\\samples\\tutorial\\api\\lineardynamic.SLDPRT", (int)swDocumentTypes_e.swDocPART, (int)swOpenDocOptions_e.swOpenDocOptions_Silent, "", ref longstatus, ref longwarnings);
            if (Part == null)
                ErrorMsg(swApp, "Failed to open lineardynamic.SLDPRT");
            //Add-in callback
            CWAddinCallBack = (CwAddincallback)swApp.GetAddInObject("CosmosWorks.CosmosWorks");
            if (CWAddinCallBack == null)
                ErrorMsg(swApp, "Failed to get CwAddincallback object");
            COSMOSWORKS = CWAddinCallBack.CosmosWorks;
            if (COSMOSWORKS == null)
                ErrorMsg(swApp, "Failed to get CosmosWorks object");
            //Get active document
            ActDoc = COSMOSWORKS.ActiveDoc;
            if (ActDoc == null)
                ErrorMsg(swApp, "Failed to get active document");
            //Create a dynamic random vibration study
            StudyMngr = ActDoc.StudyManager;
            if (StudyMngr == null)
                ErrorMsg(swApp, "Failed to get study manager object");
            sStudyName = "Dynamic_Response_Spectrum";
            Study = StudyMngr.CreateNewStudy3(sStudyName, (int)swsAnalysisStudyType_e.swsAnalysisStudyTypeDynamic, (int)swsDynamicAnalysisSubType_e.swsDynamicAnalysisSubTypeResponse, out errCode);
            Debug.Print("Linear dynamic study with response spectrum analysis");
            Debug.Print("");
            Debug.Print("Study configuration name is " + Study.ConfigurationName);
            Debug.Print("Dynamic analysis subtype as defined in swsAnalysisStudyType_e is " + Study.DynamicAnalysisSubType);
 
            Debug.Print("Dynamic study options...");
            DynStudyOptions = Study.DynamicStudyOptions;
            errCode = DynStudyOptions.GetFrequencyOption2(out freqOption, out freqValue);
            Debug.Print("  Frequency option (0=number of frequencies, 1=upper bound): " + freqOption);
            Debug.Print("  No. of frequencies or upper-bound frequency: " + freqValue);
            errCode = DynStudyOptions.GetFrequencyShiftOption2(out bChecked, out freqValue);
            Debug.Print("  Is frequency shift enabled (0=no, 1=yes)? " + bChecked);
            Debug.Print("  Frequency shift: " + freqValue);
            errCode = DynStudyOptions.SetIncompatibleBondingOption2(0); // automatic
            errCode = DynStudyOptions.SetUseSoftSpring2(0); // do not use soft springs to stabilize model
            errCode = DynStudyOptions.SetResultFolderPath2("c:\\temp");
            DynStudyOptions.SolverType = 2; // FFEPlus
            errCode = DynStudyOptions.GetResponseSpectrumClusterFactor2(out dParam);
            Debug.Print("  Cluster factor: " + dParam);
            errCode = DynStudyOptions.GetResponseSpectrumCurveInterpolation2(out param);
            Debug.Print("  Curve interpolation as defined in swsInterpolationType_e: " + param);
            errCode = DynStudyOptions.GetResponseSpectrumModeCombinationMethod2(out param);
            Debug.Print("  Mode combination method as defined in swsModeCombinationMethod_e: " + param);
            errCode = DynStudyOptions.GetResponseSpectrumUseMaterialDamping2(out param);
            Debug.Print("  Use the material damping ratio? (1 to use, 0 to not): " + param);
            Debug.Print("");
 
            //Set study result options
            Debug.Print("Study result options...");
            ResultOptions = Study.StudyResultOptions;
            ResultOptions.SaveResultsForSolutionStepsOption = 1; // save solution step results
            ResultOptions.SaveDisplacementsAndVelocitiesOption = 1; // save displacements and velocities
            ResultOptions.SaveStresses = 1; // save stresses
            //Solution step set #1
            errCode = ResultOptions.SetSolutionStepsSetInformation(1, 10, 100, 3);
            Debug.Print("  Set solution steps set #1 (10-100, inc=3)? (0=success): " + errCode);
            //Solution step set #3
            errCode = ResultOptions.SetSolutionStepsSetInformation(3, 100, 1000, 5);
            Debug.Print("  Set solution steps set #3 (100-1000, inc=5)? (0=success): " + errCode);
            Debug.Print("");
            object PID = null;
            object SelObj = null;
            object obj = null;
            //Get face by persistent ID
            boolstatus = Part.Extension.SelectByID2("", "FACE", 0.367377178180561, 0.0153999999998859, -0.443699715030164, false, 0, null, 0);
            obj = ((SelectionMgr)Part.SelectionManager).GetSelectedObject6(1, -1);
            PID = Part.Extension.GetPersistReference3(obj);
            SelObj = Part.Extension.GetObjectByPersistReference3((PID), out errCode);
            DispArray1[0] = SelObj; // face
            //Get edge by persistent ID
            boolstatus = Part.Extension.SelectByID2("", "EDGE", 0.473843326221299, 0.0160904480509885, -0.000690335842989498, false, 0, null, 0);
            obj = ((SelectionMgr)Part.SelectionManager).GetSelectedObject6(1, -1);
            PID = Part.Extension.GetPersistReference3(obj);
            CWBaseExcitationEntity = Part.Extension.GetObjectByPersistReference3((PID), out errCode);
            DispArray3[0] = CWBaseExcitationEntity; // edge
            //Get Axis1 reference geometry by persistent ID
            boolstatus = Part.Extension.SelectByID2("Axis1", "AXIS", -0.0320045390890095, 0.0639408825367532, -0.0319259521004658, false, 0, null, 0);
            obj = ((SelectionMgr)Part.SelectionManager).GetSelectedObject6(1, -1);
            PID = Part.Extension.GetPersistReference3(obj);
            CWDirectionEntity = Part.Extension.GetObjectByPersistReference3((PID), out errCode);
            pDisp5 = CWDirectionEntity;
            //Add materials
            ShellMgr = Study.ShellManager;
            if (ShellMgr == null)
                ErrorMsg(swApp, "Failed to get shell manager object");
            CWFeatObj1 = ShellMgr.GetShellAt(0, out errCode);
            if (errCode != 0)
                ErrorMsg(swApp, "Failed to get shell component");
            ShellMat = CWFeatObj1.GetDefaultMaterial();
            ShellMat.MaterialUnits = 0;
            ShellMat.SetPropertyByName("EX", 2000000000000.0, 0);
            ShellMat.SetPropertyByName("NUXY", 0.25, 0);
            errCode = CWFeatObj1.SetShellMaterial(ShellMat);
            if (errCode != 0)
                ErrorMsg(swApp, "Failed to apply material");
            CWFeatObj1.ShellBeginEdit();
            CWFeatObj1.Formulation = 1; // thick shell
            CWFeatObj1.ShellUnit = 1; // centimeters
            CWFeatObj1.ShellThickness = 5; // 5 cm
            CWFeatObj1.ShellOffsetOption = 3; //specify reference surface
            CWFeatObj1.ShellOffsetValue = 0.3;
            errCode = CWFeatObj1.ShellEndEdit();
            if (errCode != 0)
                ErrorMsg(swApp, "Failed to create shell");
            CWFeatObj1 = null;
            //Get loads and restraints manager
            LBCMgr = Study.LoadsAndRestraintsManager;
            if (LBCMgr == null)
                ErrorMsg(swApp, "Failed to get loads and restraints manager");
            Debug.Print(" ");
            //Add a restraint
            CWFeatObj3 = LBCMgr.AddRestraint(0, (DispArray3), pDisp5, out errCode);
            if (errCode != 0)
                ErrorMsg(swApp, "Failed to create restraint");
            CWFeatObj3.RestraintBeginEdit();
            CWFeatObj3.SetTranslationComponentsValues(0, 0, 1, 0.0, 0.0, 0.0);
            CWFeatObj3.SetRotationComponentsValues(0, 0, 0, 0.0, 0.0, 0.0);
            CWFeatObj3.Unit = 2;
            errCode = CWFeatObj3.RestraintEndEdit();
            if (errCode != 0)
                ErrorMsg(swApp, "Restraint end-edit failed");
            //Create mesh
            CWFeatObj4 = Study.Mesh;
            if (CWFeatObj4 == null)
                ErrorMsg(swApp, "Failed to create mesh object");
            CWFeatObj4.MesherType = 0; // standard
            CWFeatObj4.Quality = 1; // high
            errCode = Study.CreateMesh(0, MeshEleSize, MeshTol);
            if (errCode != 0)
                ErrorMsg(swApp, "Failed to create mesh");
            Debug.Print("Worst Jacobian ratio for the mesh: " + CWFeatObj4.GetWorstJacobianRatio());
            Debug.Print("");
            //Add uniform base excitation
            CWBaseExcitationU = LBCMgr.AddUniformBaseExcitation((int)swsBaseExcitationType_e.swsBaseExcitationType_Displacement, CWBaseExcitationEntity, 1, 1, 10.0, 0, 0, 0, 0, out errCode);
            if (errCode != 0)
                ErrorMsg(swApp, "Adding uniform base excitation failed");
            Debug.Print("Uniform base excitation type (0=Disp, 1=Vel, 2=Acc): " + CWBaseExcitationU.BaseExcitationType);
            int bdir1 = 0;
            int bdir2 = 0;
            int bdir3 = 0;
            CWBaseExcitationU.GetExcitationDirections(out bdir1, out bdir2, out bdir3);
            Debug.Print(" Excitation in...");
            Debug.Print("   Direction 1 (1=true)? " + bdir1);
            Debug.Print("   Direction 2 (1=true)? " + bdir2);
            Debug.Print("   Direction 3 (1=true)? " + bdir3);
            double dval1 = 0;
            double dval2 = 0;
            double dval3 = 0;
            CWBaseExcitationU.GetExcitationDirectionValues(out dval1, out dval2, out dval3);
            Debug.Print(" Excitation value in swsUnit_e units...");
            Debug.Print("   Direction 1: " + dval1);
            Debug.Print("   Direction 2: " + dval2);
            Debug.Print("   Direction 3: " + dval3);
            object[] curveData = null;
            curveData = (object[])CWBaseExcitationU.GetTimeOrFrequencyCurve();
            Debug.Print(" Displacement excitation variation with frequency data");
            Debug.Print(" (number of points, x1, y1, x2, y2...xn, yn):");
            for (i = 0; i <= curveData.GetUpperBound(0); i++)
            {
                Debug.Print("  * " + curveData[i]);
            }
            Debug.Print("  Excitation phase angle (-1 if not set): " + CWBaseExcitationU.PhaseAngle);
            Debug.Print("  Excitation phase angle unit in swsPhaseAngleUnit_e units: " + CWBaseExcitationU.PhaseAngleUnit);
            Debug.Print("  Excitation units (dependent on excitation type): " + CWBaseExcitationU.Unit);
            Debug.Print("");
            //Run analysis
            Debug.Print("Running the analysis");
            Debug.Print("");
            errCode = Study.RunAnalysis();
            if (errCode != 0)
                ErrorMsg(swApp, "Analysis failed with error code " + errCode + " - " + ProcErrCode(errCode));
            //Get results
            CWFeatObj5 = Study.Results;
            if (CWFeatObj5 == null)
                ErrorMsg(swApp, "Failed to get results object");
            Debug.Print("Study results...");
            nStep = CWFeatObj5.GetMaximumAvailableSteps();
            Debug.Print("  Maximum available steps: " + nStep);
            //Get algebraic minimum/maximum resultant displacements
            Disp = (object[])CWFeatObj5.GetMinMaxDisplacement(3, nStep, null, 0, out errCode);
            if (errCode != 0)
                ErrorMsg(swApp, "Failed to get displacement results");
            Debug.Print("  Min/max URES resultant displacements (Node, Min, Node, Max):");
            for (i = 0; i <= Disp.GetUpperBound(0); i++)
            {
                Debug.Print("  * " + Disp[i]);
            }
            Debug.Print("");
            //Get algebraic minimum/maximum von Mises stresses
            Stress = (object[])CWFeatObj5.GetMinMaxStress(9, 0, nStep, null, 3, out errCode);
            if (errCode != 0)
                ErrorMsg(swApp, "Failed to get stress results");
            Debug.Print("  Algebraic min/max von Mises stresses (Node, Min, Node, Max):");
            for (i = 0; i <= Stress.GetUpperBound(0); i++)
            {
                Debug.Print("  * " + Stress[i]);
            }
            Debug.Print("");
            //Get algebraic minimum/maximum velocities
            Velocity = (object[])CWFeatObj5.GetMinMaxVelocity(0, nStep, CWDirectionEntity, 0, out errCode);
            if (errCode != 0)
                ErrorMsg(swApp, "Failed to get velocity results");
            Debug.Print("  Algebraic min/max velocities (Node, Min, Node, Max):");
            for (i = 0; i <= Velocity.GetUpperBound(0); i++)
            {
                Debug.Print("  * " + Velocity[i]);
            }
            Debug.Print("");
            //Get algebraic minimum/maximum accelerations
            Acceleration = (object[])CWFeatObj5.GetMinMaxAcceleration(0, nStep, CWDirectionEntity, 0, out errCode);
            if (errCode != 0)
                ErrorMsg(swApp, "Failed to get acceleration results");
            Debug.Print("  Algebraic min/max accelerations (Node, Min, Node, Max):");
            for (i = 0; i <= Acceleration.GetUpperBound(0); i++)
            {
                Debug.Print("  * " + Acceleration[i]);
            }
            //Reaction forces and moments for entire model and selected face at solution step 1
            forces2 = CWFeatObj5.GetReactionForcesAndMomentsWithSelections(1, null, (int)swsForceUnit_e.swsForceUnitNOrNm, (DispArray1), out selectedAndModelReactionFM, out selectedOnlyReactionFM, out errCode);
            object[] selFM = (object[])selectedOnlyReactionFM;
            if (errCode != 0)
                ErrorMsg(swApp, "Failed to get reaction forces and moments");
            Debug.Print("  Reaction forces (N) and moments (N-m) for selected face at solution step 1 ");
            Debug.Print("  {xcoord_force, ycoord_force, zcoord_force, resultant_force, ");
            Debug.Print("   xcoord_moment, ycoord_moment, zcoord_moment, resultant_moment}:");
            for (i = 0; i <= selFM.GetUpperBound(0); i++)
            {
                Debug.Print("  * " + selFM[i]);
            }
        }
        public void ErrorMsg(SldWorks SwApp, string Message)
        {
            SwApp.SendMsgToUser2(Message, 0, 0);
            SwApp.RecordLine("'*** WARNING - General");
            SwApp.RecordLine("'*** " + Message);
            SwApp.RecordLine("");
        }
        // Process error code as defined in swsRunAnalysisError_e
        public string ProcErrCode(long errCode)
        {
            string functionReturnValue = null;
            switch (errCode)
            {
                case 0:
                    functionReturnValue = "Successful";
                    break;
                case 1:
                    functionReturnValue = "Use high quality mesh";
                    break;
                case 2:
                    functionReturnValue = "Rigid virtual wall contact must be defined";
                    break;
                case 3:
                    functionReturnValue = "Define initial temperatures to perform transient thermal analysis";
                    break;
                case 4:
                    functionReturnValue = "Multiple loads on an entity should use the same time curve";
                    break;
                case 5:
                    functionReturnValue = "Drop test study is not set up";
                    break;
                case 6:
                    functionReturnValue = "One or more static studies need to perform fatigue analysis";
                    break;
                case 7:
                    functionReturnValue = "No fatigue event defined";
                    break;
                case 8:
                    functionReturnValue = "All loads should be either time-dependent or amplitude only";
                    break;
                case 9:
                    functionReturnValue = "No SN curve available";
                    break;
                case 11:
                    functionReturnValue = "The mesh is not identical for static studies used in different events";
                    break;
                case 12:
                    functionReturnValue = "No valid shell defined";
                    break;
                case 13:
                    functionReturnValue = "Elastic modulus (EX) material property is not defined";
                    break;
                case 14:
                    functionReturnValue = "Elastic modulus (EX) should be > 0.0";
                    break;
                case 15:
                    functionReturnValue = "Poisson's Ratio should be less than 0.5";
                    break;
                case 16:
                    functionReturnValue = "Thermal conductivity is not defined";
                    break;
                case 17:
                    functionReturnValue = "Creep option for material works only in force control method";
                    break;
                case 18:
                    functionReturnValue = "Material is not defined for one or more shells";
                    break;
                case 19:
                    functionReturnValue = "Material is not defined";
                    break;
                case 20:
                    functionReturnValue = "Material is not defined for one or more components";
                    break;
                case 21:
                    functionReturnValue = "No solid body to process";
                    break;
                case 22:
                    functionReturnValue = "Authorization failed for this analysis type";
                    break;
                case 23:
                    functionReturnValue = "Mesh not found";
                    break;
                case 24:
                    functionReturnValue = "Analysis failed";
                    break;
                default:
                    functionReturnValue = "Unknown error condition";
                    break;
            }
            return functionReturnValue;
        }
 
 
        public SldWorks swApp;
    }
 
}