smiths
commented
6 years ago I'll edit in my comments below:
Under section 1.2 specifically :
- [x] _Fx missing description (https://github.com/smiths/caseStudies/blob/220c839436f38aaf2c87c4020d0ca23a278fa6c0/CaseStudies/ssp/Documentation%20Files/SRS_SSP.tex#L172)
I don't have a problem with the definition given. An abstract definition is appropriate, since Fx is used for the general theory of equilibrium. However, it should be $x$ component, not X component.
- [x] _Fy missing description (https://github.com/smiths/caseStudies/blob/220c839436f38aaf2c87c4020d0ca23a278fa6c0/CaseStudies/ssp/Documentation%20Files/SRS_SSP.tex#L174)
Also seems fine as given. However, it should be $y$ component, not Y component.
- [ ] a missing description (https://github.com/smiths/caseStudies/blob/220c839436f38aaf2c87c4020d0ca23a278fa6c0/CaseStudies/ssp/Documentation%20Files/SRS_SSP.tex#L154)
$a$ comes from StolleGuo2008. $a$ is a constant that ensures the denominator in the calculation of $K_t$ is not zero and $K_t >> k_t$.
At least in the short term, I do not really want to support the documentation of the rigid finite element method in SSP. We don't want to put too much work into these aspects of the documentation.
- [ ] A missing description (https://github.com/smiths/caseStudies/blob/220c839436f38aaf2c87c4020d0ca23a278fa6c0/CaseStudies/ssp/Documentation%20Files/SRS_SSP.tex#L156)
$A$ is also defined in StolleGuo2008. As I mentioned above, we don't want to put too much work into the rigid finite element portion of the documentation. You can say that A is a material property related to the interface stiffness in tension.
- [x] C1 missing description (https://github.com/smiths/caseStudies/blob/220c839436f38aaf2c87c4020d0ca23a278fa6c0/CaseStudies/ssp/Documentation%20Files/SRS_SSP.tex#L162)
C1_i is the shear force at the interslice interface for slice i.
- [x] C2 missing description (https://github.com/smiths/caseStudies/blob/220c839436f38aaf2c87c4020d0ca23a278fa6c0/CaseStudies/ssp/Documentation%20Files/SRS_SSP.tex#L164)
C2_i is the normal force at the interslice interface for slice i.
- [ ] lowercase kappa missing description (https://github.com/smiths/caseStudies/blob/220c839436f38aaf2c87c4020d0ca23a278fa6c0/CaseStudies/ssp/Documentation%20Files/SRS_SSP.tex#L288)
Does kappa even appear in the current documentation? The parameter $A$ mentioned above is calculated from kappa (StolleAndGuo2008), but I don't think this equation is given in the document.
- [x] can M's description be improved to be more descriptive/defining? (https://github.com/smiths/caseStudies/blob/220c839436f38aaf2c87c4020d0ca23a278fa6c0/CaseStudies/ssp/Documentation%20Files/SRS_SSP.tex#L210)
"Moment of a Body: assumed 2D allowing a scalar" isn't the best description. It isn't the moment of a body, but the moment of a force. I think we can just say "Moment of a force about a given axis".
- [x] lowercase sigma description : "plain" should be "plane"? (https://github.com/smiths/caseStudies/blob/220c839436f38aaf2c87c4020d0ca23a278fa6c0/CaseStudies/ssp/Documentation%20Files/SRS_SSP.tex#L296)
Yes, please make this change and check the Drasil version as well.
Undefined/misdefined instances:
- [x] T3 describes cohesion c, which is a symbol not mentioned in the equation it is describing or in the table of symbols (should it be c'?) (https://github.com/smiths/caseStudies/blob/220c839436f38aaf2c87c4020d0ca23a278fa6c0/CaseStudies/ssp/Documentation%20Files/SRS_SSP.tex#L736)
Yes, is should be c'.
- [x] c is not defined (mentioned in section 5.1 (Functional Requirements)) (https://github.com/smiths/caseStudies/blob/220c839436f38aaf2c87c4020d0ca23a278fa6c0/CaseStudies/ssp/Documentation%20Files/SRS_SSP.tex#L3036)
Use c' instead
- [x] _Us in T3 not defined in table of symbols (https://github.com/smiths/caseStudies/blob/220c839436f38aaf2c87c4020d0ca23a278fa6c0/CaseStudies/ssp/Documentation%20Files/SRS_SSP.tex#L733)
Can you put this in a separate issue. The theoretical model for Mohr Coloumb should be investigated.
- [x] lowercase phi not defined (mentioned in section 5.1 (Functional Requirements)) (https://github.com/smiths/caseStudies/blob/220c839436f38aaf2c87c4020d0ca23a278fa6c0/CaseStudies/ssp/Documentation%20Files/SRS_SSP.tex#L3038)
This is the same phi as in the Mohr-Coloumb constitutive equation. There is just the possibility of a different friction angle for each slice.
- [x] _(lowercase gamma)wat not defined, meant to be (lowercase gamma)w_? (section 5.1 (Functional Requirements)) (https://github.com/smiths/caseStudies/blob/220c839436f38aaf2c87c4020d0ca23a278fa6c0/CaseStudies/ssp/Documentation%20Files/SRS_SSP.tex#L3045)
Yes, this should be the specific weight of the water. Replace any occurences of wat with w.
Other:
- [x] replace "deg" with actual symbol for consistency (section 5.1 (Functional Requirements)) (https://github.com/smiths/caseStudies/blob/220c839436f38aaf2c87c4020d0ca23a278fa6c0/CaseStudies/ssp/Documentation%20Files/SRS_SSP.tex#L3038-L3039)
Yes, good idea. Please do that.
niazim3
(Issue #27)
Under section 1.2 specifically :
a missing descriptionSee comments below (https://github.com/smiths/caseStudies/blob/220c839436f38aaf2c87c4020d0ca23a278fa6c0/CaseStudies/ssp/Documentation%20Files/SRS_SSP.tex#L154)A missing descriptionSee comments below (https://github.com/smiths/caseStudies/blob/220c839436f38aaf2c87c4020d0ca23a278fa6c0/CaseStudies/ssp/Documentation%20Files/SRS_SSP.tex#L156)Undefined/misdefined instances:
Other: