Skip to content

Commit f370fcb

Browse files
authored
Update README.md [no ci]
1 parent 3c464c4 commit f370fcb

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

README.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,11 +27,14 @@ grid = get_ferrite_grid(filename)
2727
```julia
2828
grid = get_ferrite_grid(filename; user_elements::Dict{String,DataType}=Dict{String,DataType}())
2929
```
30-
Supply a dictionary with keys being element codes in the mesh file `filename` and the value being the corresponding concrete subtype of `Ferrite.AbstractCell`. Additionally, you have to overload the function
30+
Supply a dictionary with keys being element codes in the mesh file `filename` and the value being the corresponding concrete subtype of `Ferrite.AbstractCell`.
31+
32+
Additionally, you may have to overload the function
3133
```julia
3234
FerriteMeshParser.create_cell(::Type{CellType}, node_numbers, format::FerriteMeshParser.AbaqusMeshFormat) where{CellType<:Ferrite.AbstractCell}
3335
```
34-
if you have a `CellType` that is not a subtype of `Ferrite.Cell`, or if the node order of `CellType` is different from that in the input file. `create_cell` should return an instance of your subtype of `Ferrite.AbstractCell` with the given node_numbers.
36+
Overloading is required if the constructor of your `CellType` needs different constructor input arguments than a tuple of node indices in the order given in the input file.
37+
`create_cell` should return an instance of your subtype of `Ferrite.AbstractCell` with the given node_numbers.
3538

3639

3740
## Current limitations

0 commit comments

Comments
 (0)