Version: 13.0

    Show / Hide Table of Contents

    Class ProSolveOptions

    Inheritance
    System.Object
    System.MarshalByRefObject
    SMT.MastaAPIUtility.MarshalByRefObjectPermanent
    APIBase
    ProSolveOptions
    Implements
    System.IEquatable<APIBase>
    Inherited Members
    APIBase.DisconnectFromMASTA()
    APIBase.GetProperty<T>(String)
    APIBase.SetProperty(String, Object)
    APIBase.cacheRpds
    APIBase.clearCachedRpds()
    APIBase.getNamedObjectList<TElementType>(String)
    APIBase.getExpandableProperty<TReturnType>(String)
    APIBase.callPartialMethod(String, (T1, T2)<Type, Object>[])
    APIBase.callPartialMethod<T>(String, T)
    APIBase.callPartialMethod<T>(String, (T1, T2)<Type, Object>, T)
    APIBase.callPartialMethod<T>(String, (T1, T2)<Type, Object>, (T1, T2)<Type, Object>, T)
    APIBase.callPartialMethod<T>(String, (T1, T2)<Type, Object>, (T1, T2)<Type, Object>, (T1, T2)<Type, Object>, T)
    APIBase.callPartialMethod<T1, T2>(String, (T1, T2)<Type, Object>, T1, T2)
    APIBase.getPartialProperty(String)
    APIBase.setPartialProperty(String, Object)
    APIBase.IsValid(String)
    APIBase.IsReadOnly(String)
    APIBase.isInvalid
    APIBase.DocumentationUrl()
    APIBase.ToString()
    APIBase.RunPython<T>(String, String, Object)
    APIBase.RunPythonCode<T>(String, String, Object)
    APIBase.RunPythonCode<T>(String)
    APIBase.RunPython<T>(String, String)
    APIBase.CreateObjRef(Type)
    APIBase.RunPython(String, String, Object)
    APIBase.createWrappedRange(Double, Double)
    APIBase.createWrappedVector2D(Double, Double)
    APIBase.createWrappedPosition3D(Double, Double, Double)
    APIBase.Equals(APIBase)
    APIBase.GetHashCode()
    APIBase.Equals(Object)
    SMT.MastaAPIUtility.MarshalByRefObjectPermanent.InitializeLifetimeService()
    Namespace: SMT.MastaAPI.FETools.VfxTools
    Assembly: SMT.MastaAPI.13.0.dll
    Syntax
    public class ProSolveOptions : APIBase, IEquatable<APIBase>

    Fields

    _parent

    Declaration
    protected readonly APIBase _parent
    Field Value
    Type Description
    APIBase

    Properties

    CompensateForSingularitiesInModel

    Singularities can occur in a model due to e.g. unconstrained degrees of freedom. It is best to fix these problems and turn this option off. If this is not possible then this option will attempt to penalise these singularities to allow the solution to proceed.

    Declaration
    public bool CompensateForSingularitiesInModel { get; set; }
    Property Value
    Type Description
    System.Boolean

    MPCType

    Multi-Point Constraint type.

    Declaration
    public EnumWithSelectedValue<ProSolveMpcType> MPCType { get; set; }
    Property Value
    Type Description
    EnumWithSelectedValue<ProSolveMpcType>

    PenaltyFactor

    Scales the calculated penalty factor for each MPC constraint

    Declaration
    public Overridable<double> PenaltyFactor { get; set; }
    Property Value
    Type Description
    Overridable<System.Double>

    ReportNames

    Declaration
    public IReadOnlyList<string> ReportNames { get; }
    Property Value
    Type Description
    System.Collections.Generic.IReadOnlyList<System.String>

    TypeOfSolver

    Type of solver to use

    Declaration
    public EnumWithSelectedValue<ProSolveSolverType> TypeOfSolver { get; set; }
    Property Value
    Type Description
    EnumWithSelectedValue<ProSolveSolverType>

    UseJacobianChecking

    Non-positive Jacobian contributions during solid element volume integrations will produce errors unless the checking is turned off.

    Declaration
    public bool UseJacobianChecking { get; set; }
    Property Value
    Type Description
    System.Boolean

    UseOutOfCoreSolver

    When using the out of core solver some parts of the solution are written to the hard drive rather than the memory. This reduces the memory required to perform the analysis, but can significantly increase the run-time.

    Declaration
    public bool UseOutOfCoreSolver { get; set; }
    Property Value
    Type Description
    System.Boolean

    Methods

    GetActiveReportWithEncodedImages()

    Declaration
    public string GetActiveReportWithEncodedImages()
    Returns
    Type Description
    System.String

    GetDefaultReportWithEncodedImages()

    Declaration
    public string GetDefaultReportWithEncodedImages()
    Returns
    Type Description
    System.String

    GetNamedReportWithEncodedImages(String)

    Declaration
    public string GetNamedReportWithEncodedImages(string reportName)
    Parameters
    Type Name Description
    System.String reportName
    Returns
    Type Description
    System.String

    OutputActiveReportAsTextTo(String)

    Declaration
    public void OutputActiveReportAsTextTo(string filePath)
    Parameters
    Type Name Description
    System.String filePath

    OutputActiveReportTo(String)

    Declaration
    public void OutputActiveReportTo(string filePath)
    Parameters
    Type Name Description
    System.String filePath

    OutputDefaultReportTo(String)

    Declaration
    public void OutputDefaultReportTo(string filePath)
    Parameters
    Type Name Description
    System.String filePath

    OutputNamedReportAsMastaReport(String, String)

    Declaration
    public void OutputNamedReportAsMastaReport(string reportName, string filePath)
    Parameters
    Type Name Description
    System.String reportName
    System.String filePath

    OutputNamedReportAsTextTo(String, String)

    Declaration
    public void OutputNamedReportAsTextTo(string reportName, string filePath)
    Parameters
    Type Name Description
    System.String reportName
    System.String filePath

    OutputNamedReportTo(String, String)

    Declaration
    public void OutputNamedReportTo(string reportName, string filePath)
    Parameters
    Type Name Description
    System.String reportName
    System.String filePath

    Implements

    System.IEquatable<T>

    Extension Methods

    UtilityMethods.IsReadOnly<T>(T, Expression<Func<T, Object>>)
    UtilityMethods.IsValid<T>(T, Expression<Func<T, Object>>)
    UtilityMethods.IsMethodValid<T>(T, Expression<Func<T, Action>>)
    UtilityMethods.IsMethodReadOnly<T>(T, Expression<Func<T, Action>>)
    In This Article
    • Fields
      • _parent
    • Properties
      • CompensateForSingularitiesInModel
      • MPCType
      • PenaltyFactor
      • ReportNames
      • TypeOfSolver
      • UseJacobianChecking
      • UseOutOfCoreSolver
    • Methods
      • GetActiveReportWithEncodedImages()
      • GetDefaultReportWithEncodedImages()
      • GetNamedReportWithEncodedImages(String)
      • OutputActiveReportAsTextTo(String)
      • OutputActiveReportTo(String)
      • OutputDefaultReportTo(String)
      • OutputNamedReportAsMastaReport(String, String)
      • OutputNamedReportAsTextTo(String, String)
      • OutputNamedReportTo(String, String)
    • Implements
    • Extension Methods
    Back to top