Skip to content
GitLab
Menu
Projects
Groups
Snippets
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
Menu
Open sidebar
tools
frackit
Commits
25818cc3
Commit
25818cc3
authored
Jan 31, 2020
by
Dennis Gläser
Browse files
[ex2][README] improve doc
parent
2cff8125
Changes
1
Hide whitespace changes
Inline
Side-by-side
appl/example2/README.md
View file @
25818cc3
...
...
@@ -30,7 +30,7 @@ and write
auto
constraintsOnBoundary
=
constraintsOnSelf
;
```
to create a new constraints object. Within the loop in which the entities are created
to create a new constraints object. Within the loop in which the entities are created
,
these constraints are enforced:
```
cpp
...
...
@@ -61,7 +61,7 @@ where `computeContainedMagnitude()` is a free function that returns the length/a
of the part of a geometry that is contained inside of another geometry.
Finally, after the desired number of entities has been created, we cast the entities
into an instance of
a
`ContainedEntityNetwork`
, using the corresponding builder class:
into an instance of
the class
`ContainedEntityNetwork`
, using the corresponding builder class:
```
cpp
ContainedEntityNetworkBuilder
builder
;
...
...
@@ -74,10 +74,10 @@ The class `ContainedEntityNetworkBuilder` returns an instance of a `ContainedEnt
when the
`build()`
function is called (see below). This network implementation contains information
on (sub-)domains and which entities are embedded in which (sub-)domain. Each (sub-)domain
receives a unique identifier by means of the
`Id`
class. By calling
`builder.addConfiningSubDomain(domain, Id(1))
;
`
, we define the (sub-)domain to be
`builder.addConfiningSubDomain(domain, Id(1))`
, we define the (sub-)domain to be
confining, i.e. entities that are added to this (sub-)domain will be confined to it
by cutting away all parts that lie outside the (sub-)domain. In contrast to that,
one could call
`builder.addSubDomain(domain, Id(1))
;
`
, in which case embedded networks
one could call
`builder.addSubDomain(domain, Id(1))`
, in which case embedded networks
will not be confined (see
[
example 3
][
2
]
). Entities are associated with the (sub-)
domain they are embedded in, and are added to the builder class by writing
...
...
Write
Preview
Supports
Markdown
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment