Skip to content

Commit

Permalink
documentation working
Browse files Browse the repository at this point in the history
franaudo committed Dec 19, 2023
1 parent 2434155 commit 940376c
Showing 5 changed files with 33 additions and 59 deletions.
20 changes: 10 additions & 10 deletions docs/api/compas_fea2.model.rst
Original file line number Diff line number Diff line change
@@ -35,7 +35,7 @@ Elements
.. autosummary::
:toctree: generated/

Element
_Element
MassElement
BeamElement
SpringElement
@@ -44,7 +44,7 @@ Elements
TieElement
ShellElement
MembraneElement
Element3D
_Element3D
TetrahedronElement
HexahedronElement

@@ -54,7 +54,7 @@ Releases
.. autosummary::
:toctree: generated/

BeamEndRelease
_BeamEndRelease
BeamEndPinRelease
BeamEndSliderRelease

@@ -64,8 +64,8 @@ Constraints
.. autosummary::
:toctree: generated/

Constraint
MultiPointConstraint
_Constraint
_MultiPointConstraint
TieMPC
BeamMPC
TieConstraint
@@ -76,7 +76,7 @@ Materials
.. autosummary::
:toctree: generated/

Material
_Material
UserMaterial
Stiff
ElasticIsotropic
@@ -94,7 +94,7 @@ Sections
.. autosummary::
:toctree: generated/

Section
_Section
BeamSection
SpringSection
AngleSection
@@ -119,7 +119,7 @@ Boundary Conditions
.. autosummary::
:toctree: generated/

BoundaryCondition
_BoundaryCondition
GeneralBC
FixedBC
PinnedBC
@@ -139,7 +139,7 @@ Initial Conditions
.. autosummary::
:toctree: generated/

InitialCondition
_InitialCondition
InitialTemperatureField
InitialStressField

@@ -149,7 +149,7 @@ Groups
.. autosummary::
:toctree: generated/

Group
_Group
NodesGroup
ElementsGroup
FacesGroup
10 changes: 5 additions & 5 deletions docs/api/compas_fea2.problem.rst
Original file line number Diff line number Diff line change
@@ -18,9 +18,9 @@ Steps
.. autosummary::
:toctree: generated/

Step
GeneralStep
Perturbation
_Step
_GeneralStep
_Perturbation
ModalAnalysis
ComplexEigenValue
StaticStep
@@ -36,7 +36,7 @@ Prescribed Fields
.. autosummary::
:toctree: generated/

PrescribedField
_PrescribedField
PrescribedTemperatureField

Loads
@@ -45,7 +45,7 @@ Loads
.. autosummary::
:toctree: generated/

Load
_Load
PrestressLoad
PointLoad
LineLoad
30 changes: 9 additions & 21 deletions src/compas_fea2/model/materials/concrete.py
Original file line number Diff line number Diff line change
@@ -7,18 +7,10 @@
from ...utilities._utils import extend_docstring

class Concrete(_Material):
"""
Concrete
========
Elastic and plastic-cracking Eurocode based concrete material
Note
----
The concrete model is based on Eurocode 2 up to fck=90 MPa.
"""Elastic and plastic-cracking Eurocode based concrete material
Additional Parameters and attributes
------------------------------------
Parameters
----------
fck : float
Characteristic (5%) 28 day cylinder strength [MPa].
v : float
@@ -101,16 +93,12 @@ def __str__(self):
self.name, self.density, self.E, self.v, self.G, self.fck, self.fr
)

@extend_docstring(_Material)
# @extend_docstring(_Material)
class ConcreteSmearedCrack(_Material):
"""
ConcreteSmearedCrack
====================
Elastic and plastic, cracking concrete material.
"""Elastic and plastic, cracking concrete material.
Additional Parameters and Attributes
------------------------------------
Parameters
----------
E : float
Young's modulus E.
v : float
@@ -126,8 +114,8 @@ class ConcreteSmearedCrack(_Material):
fr : list
Failure ratios.
Additional Attributes
---------------------
Attributes
----------
E : float
Young's modulus E.
v : float
28 changes: 7 additions & 21 deletions src/compas_fea2/model/materials/material.py
Original file line number Diff line number Diff line change
@@ -6,8 +6,7 @@
from compas_fea2.utilities._utils import extend_docstring

class _Material(FEAData):
"""Basic Material parameters and attributes
========================================
"""Basic Material
Parameters
----------
@@ -77,14 +76,9 @@ def __html__(self):
# ==============================================================================
# linear elastic
# ==============================================================================
@extend_docstring(_Material)
# @extend_docstring(_Material)
class ElasticOrthotropic(_Material):
"""
ElasticOrthotropic material
===========================
Elastic, orthotropic and homogeneous material
Additional paramenters and attributes:
"""Elastic, orthotropic and homogeneous material
Parameters
----------
@@ -175,11 +169,9 @@ def __str__(self):
self.Gzx,
)

@extend_docstring(_Material)
# @extend_docstring(_Material)
class ElasticIsotropic(_Material):
"""
Elastic, isotropic and homogeneous material
===========================================
"""Elastic, isotropic and homogeneous material
Parameters
----------
@@ -234,15 +226,9 @@ def __init__(self, *, density, expansion=None, name=None, **kwargs):
# ==============================================================================
# non-linear general
# ==============================================================================
@extend_docstring(_Material)
# @extend_docstring(_Material)
class ElasticPlastic(ElasticIsotropic):
"""
ElasticPlastic
==============
Elastic and plastic, isotropic and homogeneous material.
Additional parameters and attributes.
"""Elastic and plastic, isotropic and homogeneous material.
Parameters
----------
4 changes: 2 additions & 2 deletions src/compas_fea2/model/materials/steel.py
Original file line number Diff line number Diff line change
@@ -24,8 +24,8 @@ class Steel(ElasticIsotropic):
eu : float
Ultimate strain.
Attributes
----------
Additional Attributes
---------------------
E : float
Young's modulus E.
v : float

0 comments on commit 940376c

Please sign in to comment.