diff --git a/dev/.documenter-siteinfo.json b/dev/.documenter-siteinfo.json index 8d59513..8637db8 100644 --- a/dev/.documenter-siteinfo.json +++ b/dev/.documenter-siteinfo.json @@ -1 +1 @@ -{"documenter":{"julia_version":"1.10.4","generation_timestamp":"2024-07-19T22:11:40","documenter_version":"1.5.0"}} \ No newline at end of file +{"documenter":{"julia_version":"1.10.4","generation_timestamp":"2024-07-22T16:12:43","documenter_version":"1.5.0"}} \ No newline at end of file diff --git a/dev/api/index.html b/dev/api/index.html index 363e15c..75fb97e 100644 --- a/dev/api/index.html +++ b/dev/api/index.html @@ -1,2 +1,2 @@ -API Reference · MeshTools
GitHub

API Reference

MeshTools

MeshTools.contour — Function
contour(f::F, m::Mesh, l::T) where {F<:Function, T<:Real) -> Vector{Vector{NTuple{2}}}

Find contour lines of function f at level l. The function f can be of the form f(x,y) or f(p::Point2).

source
MeshTools.create_mesh — Function
create_mesh(outer::P; inner=Vector{P}[], outer_length=nothing, inner_lengths=nothing, spline=true, spline_inner=fill(spline,length(inner)) where P<:Vector{NTuple{2}}

Create a Triangular mesh from a vector of tuples using Gmsh. Interior boundaries define holes. Returns Meshes.SimpleMesh

source
MeshTools.integrate — Function
integrate(func, poly::T; n=6) where T<:Ngon

Integrate func(r,z) over polygon with n order quadrature points

source
integrate(func, m::Mesh; n=6)

Integrate func(r,z) over mesh with n order quadrature points

source
MeshTools.quad_points — Function
quad_points(tri::Triangle, ::Val{N}; w=1.0) where N

Given a triangle returns a list of evaluation points [(r,z,weight),...] n number of quadrature points. currently: 1, 3 or 6 w weight scale factor default = 1 Coefficients taken from http://www.cs.rpi.edu/~flaherje/pdf/fea6.pdf Joseph E. Flaherty course notes, Rensselaer Polytechnic Institute

source
quad_points(poly::Ngon, ::Val{N}) where N

Given a polygon calculates a set of quadrature points and weights, by splitting the polygon into triangles. returns a list of evaluation points and weights [(r,z,weight),...] These are normalised to calculate the average value of a function over the polygon; multiply by the area to get the integral. n number of quadrature points in each triangle currently: 1, 3 or 6

source
quad_points(m::Mesh, ::Val{N}) where N

Calculate quadrature points for all elements in the mesh with n order quadrature points

source
+API Reference · MeshTools
GitHub

API Reference

MeshTools

MeshTools.contour — Function
contour(f::F, m::Mesh, l::T) where {F<:Function, T<:Real) -> Vector{Vector{NTuple{2}}}

Find contour lines of function f at level l. The function f can be of the form f(x,y) or f(p::Point2).

source
MeshTools.create_mesh — Function
create_mesh(outer::P; inner=Vector{P}[], outer_length=nothing, inner_lengths=nothing, spline=true, spline_inner=fill(spline,length(inner)) where P<:Vector{NTuple{2}}

Create a Triangular mesh from a vector of tuples using Gmsh. Interior boundaries define holes. Returns Meshes.SimpleMesh

source
MeshTools.integrate — Function
integrate(func, poly::T; n=6) where T<:Ngon

Integrate func(r,z) over polygon with n order quadrature points

source
integrate(func, m::Mesh; n=6)

Integrate func(r,z) over mesh with n order quadrature points

source
MeshTools.quad_points — Function
quad_points(tri::Triangle, ::Val{N}; w=1.0) where N

Given a triangle returns a list of evaluation points [(r,z,weight),...] n number of quadrature points. currently: 1, 3 or 6 w weight scale factor default = 1 Coefficients taken from http://www.cs.rpi.edu/~flaherje/pdf/fea6.pdf Joseph E. Flaherty course notes, Rensselaer Polytechnic Institute

source
quad_points(poly::Ngon, ::Val{N}) where N

Given a polygon calculates a set of quadrature points and weights, by splitting the polygon into triangles. returns a list of evaluation points and weights [(r,z,weight),...] These are normalised to calculate the average value of a function over the polygon; multiply by the area to get the integral. n number of quadrature points in each triangle currently: 1, 3 or 6

source
quad_points(m::Mesh, ::Val{N}) where N

Calculate quadrature points for all elements in the mesh with n order quadrature points

source
diff --git a/dev/index.html b/dev/index.html index 47aa2ce..9b8f844 100644 --- a/dev/index.html +++ b/dev/index.html @@ -1,2 +1,2 @@ -MeshTools.jl · MeshTools
GitHub
+MeshTools.jl · MeshTools
GitHub
diff --git a/dev/license/index.html b/dev/license/index.html index b86bff6..ec9e8f4 100644 --- a/dev/license/index.html +++ b/dev/license/index.html @@ -8,4 +8,4 @@ comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier - identification within third-party archives.

Copyright 2024 General Atomics

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

+ identification within third-party archives.

Copyright 2024 General Atomics

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

diff --git a/dev/notice/index.html b/dev/notice/index.html index c1a5783..af081ad 100644 --- a/dev/notice/index.html +++ b/dev/notice/index.html @@ -1,2 +1,2 @@ -Notice · MeshTools
GitHub

MeshTools.jl Notice

The purpose of this NOTICE file is to provide legal notices and acknowledgments that must be displayed to users in any derivative works or distributions. This file does not alter the terms of the Apache 2.0 license that governs the use and distribution of the MeshTools.jl package.

Development Attribution

MeshTools.jl was originally developed under the FUSE project by the Magnetic Fusion Energy group at General Atomics.

Citation

If this software contributes to an academic publication, please cite it as follows:

O. Meneghini, T. Slendebroek, B.C. Lyons, K. McLaughlin, J. McClenaghan, L. Stagner, J. Harvey, T.F. Neiser, A. Ghiozzi, G. Dose, J. Guterl, A. Zalzali, T. Cote, N. Shi, D. Weisberg, S.P. Smith, B.A. Grierson, FUSE: A next generation framework for integrated design of fusion pilot plants, Proceedings of the IAEA FEC 2023 Conference, (2023)

Trademark Notice

The names "General Atomics", and any associated logos or images, are trademarks of General Atomics. Use of these trademarks without prior written consent from General Atomics is strictly prohibited. Users cannot imply endorsement by General Atomics or contributors to the project simply because the project is part of their work.

Copyright (c) 2024 General Atomics

Version

Version: v1.0

+Notice · MeshTools
GitHub

MeshTools.jl Notice

The purpose of this NOTICE file is to provide legal notices and acknowledgments that must be displayed to users in any derivative works or distributions. This file does not alter the terms of the Apache 2.0 license that governs the use and distribution of the MeshTools.jl package.

Development Attribution

MeshTools.jl was originally developed under the FUSE project by the Magnetic Fusion Energy group at General Atomics.

Citation

If this software contributes to an academic publication, please cite it as follows:

O. Meneghini, T. Slendebroek, B.C. Lyons, K. McLaughlin, J. McClenaghan, L. Stagner, J. Harvey, T.F. Neiser, A. Ghiozzi, G. Dose, J. Guterl, A. Zalzali, T. Cote, N. Shi, D. Weisberg, S.P. Smith, B.A. Grierson, FUSE: A next generation framework for integrated design of fusion pilot plants, Proceedings of the IAEA FEC 2023 Conference, (2023)

Trademark Notice

The names "General Atomics", and any associated logos or images, are trademarks of General Atomics. Use of these trademarks without prior written consent from General Atomics is strictly prohibited. Users cannot imply endorsement by General Atomics or contributors to the project simply because the project is part of their work.

Copyright (c) 2024 General Atomics

Version

Version: v1.0