:class:`ThermalAnalysis`
========================


.. py:class:: ansys.dyna.core.pre.dynabase.ThermalAnalysis

   Bases: :py:obj:`BaseObj`


   
   Activates thermal analysis and defines associated control parameters.
















   ..
       !! processed by numpydoc !!


.. py:currentmodule:: ThermalAnalysis

Overview
--------

.. tab-set::



   .. tab-item:: Methods

      .. list-table::
          :header-rows: 0
          :widths: auto

          * - :py:attr:`~set_timestep`
            - Set time step controls for the thermal solution in a thermal only or coupled structural/thermal analysis.
          * - :py:attr:`~set_solver`
            - Set options for the thermal solution in a thermal only or coupled structural-thermal analysis.
          * - :py:attr:`~set_nonlinear`
            - Set parameters for a nonlinear thermal or coupled structural/thermal analysis.
          * - :py:attr:`~create`
            - Create a thermal analysis.



   .. tab-item:: Attributes

      .. list-table::
          :header-rows: 0
          :widths: auto

          * - :py:attr:`~defined_solver`
            - 
          * - :py:attr:`~defined_timestep`
            - 
          * - :py:attr:`~defined_nonlinear`
            - 
          * - :py:attr:`~stub`
            - 
          * - :py:attr:`~type`
            - 






Import detail
-------------

.. code-block:: python

    from ansys.dyna.core.pre.dynabase import ThermalAnalysis


Attribute detail
----------------

.. py:attribute:: defined_solver
   :value: False


.. py:attribute:: defined_timestep
   :value: False


.. py:attribute:: defined_nonlinear
   :value: False


.. py:attribute:: stub

.. py:attribute:: type
   :value: 'analysis_thermal'




Method detail
-------------

.. py:method:: set_timestep(timestep_control=ThermalAnalysisTimestep.FIXED, initial_timestep=0)

   
   Set time step controls for the thermal solution in a thermal only or coupled structural/thermal analysis.


   :Parameters:

       **timestep_control** : :obj:`ThermalAnalysisTimestep`
           Time step control.

       **initial_timestep** : :class:`python:float`, :obj:`optional`
           Initial thermal time step. The default is ``0``.














   ..
       !! processed by numpydoc !!

.. py:method:: set_solver(analysis_type=ThermalAnalysisType.STEADY_STATE)

   
   Set options for the thermal solution in a thermal only or coupled structural-thermal analysis.


   :Parameters:

       **analysis_type** : :obj:`ImplicitAnalysis`
           Thermal analysis type.














   ..
       !! processed by numpydoc !!

.. py:method:: set_nonlinear(convergence_tol=0.0001, divergence=0.5)

   
   Set parameters for a nonlinear thermal or coupled structural/thermal analysis.


   :Parameters:

       **convergence_tol** : :class:`python:float`
           Convergence tolerance for temperature.

       **divergence** : :class:`python:float`
           Divergence control parameter.














   ..
       !! processed by numpydoc !!

.. py:method:: create()

   
   Create a thermal analysis.
















   ..
       !! processed by numpydoc !!