.. _ShallowFoundationGen:

ShallowFoundationGen
^^^^^^^^^^^^^^^^^^^^

This command generates a two-dimensional Beam-on-Nonlinear-Winkler-Foundation (BNWF) mesh for shallow footing analysis. It reads footing and soil properties from an input file and writes a Tcl source file ``Foundation_$FoundationTag.tcl`` containing nodes; elastic beam-column footing elements; zeroLength soil springs; materials; and boundary conditions. Source the generated file after running this command.

.. function:: ShallowFoundationGen $FoundationTag $ConnectNode $InputFileName $FootingCondition

.. csv-table::
   :header: "Argument", "Type", "Description"
   :widths: 10, 10, 40

   $FoundationTag, |integer|, foundation identifier (also used in output file naming)
   $ConnectNode, |integer|, node tag in the structural model connected to the footing
   $InputFileName, |string|, path to input file with soil; footing; and mesh parameters
   $FootingCondition, |integer|, foundation base condition code from 1 to 5

.. note::

   1. **Footing condition codes:** 1 = fixed base; 2 = elastic vertical springs with sliding restrained; 3 = elastic vertical and horizontal springs; 4 = ``QzSimple2`` vertical springs with sliding restrained; 5 = ``QzSimple2`` vertical plus ``PxSimple1`` and ``TxSimple1`` horizontal springs.

   2. Material tags generated by this command start at 101; keep structural material tags at 100 or below.

   3. The input file may use ``CapSoil $Qult $Pult $Tult $Kv $Kh`` to specify strength and stiffness directly instead of computing them from soil properties.

   4. This is a model-generation utility; it does not create a single finite element.

.. admonition:: Example

   1. **Tcl Code**

   .. code-block:: tcl

      ShallowFoundationGen 1 10 footingInput.dat 4
      source Foundation_1.tcl

   2. **Python Code**

   .. code-block:: python

      ShallowFoundationGen(1, 10, 'footingInput.dat', 4)
      source('Foundation_1.tcl')

Code developed by: Prishati Raychowdhury, UC San Diego