Skip to content

Commit 1b2c287

Browse files
committed
add more details in code #180
/cc @prudhomm @vincentchabannes can you please review that what I added is correct ?
1 parent d90c78e commit 1b2c287

File tree

1 file changed

+61
-27
lines changed

1 file changed

+61
-27
lines changed

toolboxes/modules/cfpdes/partials/introduction.adoc

+61-27
Original file line numberDiff line numberDiff line change
@@ -104,17 +104,22 @@ NOTE: In the following, `mu` is a parameter defined e.g. in the `Parameters` sec
104104
{
105105
"Models":
106106
{
107-
"cfpdes":{
108-
"equations":["myscalarpde"]
107+
"cfpdes":
108+
{
109+
"equations":["myscalarpde"] <1>
109110
},
110-
"mypde":{
111-
"setup":{
112-
"unknown":{
113-
"basis":"Pch1", // the unknown is a scalar field
114-
"name":"u",
115-
"symbol":"u"
111+
"myscalarpde": <2>
112+
{
113+
"setup":
114+
{
115+
"unknown":
116+
{
117+
"basis":"Pch1", // the unknown is a scalar field <3>
118+
"name":"u", <4>
119+
"symbol":"u" <4>
116120
},
117-
"coefficients":{
121+
"coefficients": <5>
122+
{
118123
"d": "1",
119124
"c": "x+y:x:y",
120125
"c": "{x+y,x,y,x-y}:t:x:y", // 2D matrix
@@ -128,7 +133,8 @@ NOTE: In the following, `mu` is a parameter defined e.g. in the `Parameters` sec
128133
}
129134
}
130135
},
131-
"Parameters":{
136+
"Parameters": <6>
137+
{
132138
"mu": 0.5
133139
}
134140
}
@@ -143,17 +149,22 @@ NOTE: In the following, `mu` is a parameter defined e.g. in the `Parameters` sec
143149
{
144150
"Models":
145151
{
146-
"cfpdes":{
147-
"equations":["myvectorialpde"]
152+
"cfpdes":
153+
{
154+
"equations":["myvectorialpde"] <1>
148155
},
149-
"mypde":{
150-
"setup":{
151-
"unknown":{
152-
"basis":"Pch1v", // the unknown is a vector field
153-
"name":"u",
154-
"symbol":"u"
156+
"myvectorialpde": <2>
157+
{
158+
"setup":
159+
{
160+
"unknown":
161+
{
162+
"basis":"Pch1v", // the unknown is a vector field <3>
163+
"name":"u", <4>
164+
"symbol":"u" <4>
155165
},
156-
"coefficients":{
166+
"coefficients": <5>
167+
{
157168
"d": "1",
158169
"c": "x+y:x:y",
159170
"c": "{x+y,x,y,x-y}:t:x:y", // 2D matrix
@@ -168,14 +179,22 @@ NOTE: In the following, `mu` is a parameter defined e.g. in the `Parameters` sec
168179
}
169180
}
170181
},
171-
"Parameters":{
182+
"Parameters": <6>
183+
{
172184
"mu": 0.5
173185
}
174186
}
175187
176188
----
177189
****
178190

191+
<.> The name of the equation to be considered, if many equations are defined, they must be listed here.
192+
<.> The name of the equation for definition.
193+
<.> Functional space used in the discretization of the equation.
194+
<.> The name, and symbol of the unknown.
195+
<.> Definition of the coefficients involved in the equation.
196+
<.> Definition of parameters involved in the equation.
197+
179198

180199
== Initial Conditions
181200

@@ -188,13 +207,18 @@ NOTE: the shape of the initial condition must be the same as the unknown shape.
188207
****
189208
[source,json]
190209
----
191-
"InitialConditions":{
192-
"mypde": {
193-
"u": {
194-
"Expression": {
195-
"myic": {
196-
"markers": "Omega",
197-
"expr": "2*cos(t)*sin(x)*cos(y):t:x:y"
210+
"InitialConditions": <1>
211+
{
212+
"mypde": <2>
213+
{
214+
"u": <3>
215+
{
216+
"Expression":
217+
{
218+
"myic": <4>
219+
{
220+
"markers": "Omega", <5>
221+
"expr": "2*cos(t)*sin(x)*cos(y):t:x:y" <6>
198222
}
199223
}
200224
}
@@ -203,6 +227,14 @@ NOTE: the shape of the initial condition must be the same as the unknown shape.
203227
----
204228
****
205229

230+
<.> Keyword for initial conditions
231+
<.> The name of the equation
232+
<.> The name of the unknown
233+
<.> The name of the initial condition
234+
<.> The physical entity (associated to the mesh) to which the condition is applied.
235+
<.> The expression of the initial condition. See more details in xref:toolboxes:ROOT:modeling-analysis-using-json-files.adoc#_initialconditions[the json specifications].
236+
237+
206238
== Boundary Conditions
207239

208240
Here are supported boundary conditions
@@ -305,6 +337,8 @@ The user provides the expression for stem:[(g_i)_{i=1\dots N}] in the `.json` fi
305337
<.> The physical entity (associated to the mesh) to which the condition is applied.
306338
<.> Expression of stem:[g_i]. See more details in xref:toolboxes:ROOT:modeling-analysis-using-json-files.adoc#_boundaryconditions[the json specifications].
307339

340+
NOTE: Because of the presence of `heat_T` in the expression, this will be considered as a non-linear condition.
341+
308342
=== Robin
309343

310344
Robin boundary condition is a type of boundary condition that combines both Dirichlet and Neumann boundary conditions.

0 commit comments

Comments
 (0)