[FTheoryTools] Make calabi_yau_hypersurface attribute of AbstractFTheoryModels

Author: HereAround

experimental/FTheoryTools/docs/src/generalities.md

@@ -16,12 +16,13 @@ of functionality is shared across them. This page documents that common interfac
 ## Model Geometry and Base Specification
 
 These attributes describe the geometric building blocks of the F-theory model—its ambient space, fiber
-ambient space, and base.
+ambient space, base space and the Calabi–Yau hypersurface.
 
 ```@docs
 ambient_space(m::AbstractFTheoryModel)
 base_space(m::AbstractFTheoryModel)
 fiber_ambient_space(m::AbstractFTheoryModel)
+calabi_yau_hypersurface(m::AbstractFTheoryModel)
 ```
 
 You can also check whether the base space is fully specified as a concrete geometry, or whether it is

experimental/FTheoryTools/docs/src/hypersurface.md

@@ -101,7 +101,6 @@ The following attributes are **specific to hypersurface models** and do not gene
 
 ```@docs
 hypersurface_equation(h::HypersurfaceModel)
-calabi_yau_hypersurface(h::HypersurfaceModel)
 weierstrass_model(h::HypersurfaceModel)
 global_tate_model(h::HypersurfaceModel)
 ```

experimental/FTheoryTools/docs/src/tate.md

@@ -191,7 +191,6 @@ tate_polynomial(t::GlobalTateModel)
 hypersurface_equation(t::GlobalTateModel)
 tate_ideal_sheaf(t::GlobalTateModel)
 weierstrass_model(t::GlobalTateModel)
-calabi_yau_hypersurface(t::GlobalTateModel)
 ```
 
 ---

experimental/FTheoryTools/docs/src/weierstrass.md

@@ -162,7 +162,6 @@ weierstrass_section_g(w::WeierstrassModel)
 weierstrass_polynomial(w::WeierstrassModel)
 hypersurface_equation(w::WeierstrassModel)
 weierstrass_ideal_sheaf(w::WeierstrassModel)
-calabi_yau_hypersurface(w::WeierstrassModel)
 ```
 
 ---

experimental/FTheoryTools/src/AbstractFTheoryModels/Attributes/basic_attributes.jl

@@ -78,6 +78,51 @@ function model_index(m::AbstractFTheoryModel)
 end
 
 
+@doc raw"""
+    calabi_yau_hypersurface(m::AbstractFTheoryModel)
+
+Return the Calabi–Yau hypersurface that defines the hypersurface model
+as a closed subvariety of its toric ambient space.
+
+# Examples
+```jldoctest
+julia> w =  weierstrass_model_over_projective_space(3)
+Weierstrass model over a concrete base
+
+julia> calabi_yau_hypersurface(w)
+Closed subvariety of a normal toric variety
+
+julia> t = global_tate_model_over_projective_space(2)
+Global Tate model over a concrete base
+
+julia> calabi_yau_hypersurface(t)
+Closed subvariety of a normal toric variety
+
+julia> b = projective_space(NormalToricVariety, 2);
+
+julia> kb = anticanonical_divisor_class(b);
+
+julia> fiber_ambient = weighted_projective_space(NormalToricVariety, [2, 3, 1]);
+
+julia> set_coordinate_names(fiber_ambient, ["x", "y", "z"]);
+
+julia> p = "x^3 - y^2 + x1^12 * x * z^4 + x2^18 * z^6 + 13 * x3^3*x*y*z";
+
+julia> h = hypersurface_model(b, fiber_ambient, [2 * kb, 3 * kb], p; completeness_check=false)
+Hypersurface model over a concrete base
+
+julia> calabi_yau_hypersurface(h)
+Closed subvariety of a normal toric variety
+```
+"""
+@attr ClosedSubvarietyOfToricVariety function calabi_yau_hypersurface(m::AbstractFTheoryModel)
+  @req (m isa HypersurfaceModel || m isa WeierstrassModel || m isa GlobalTateModel) "Calabi-Yau hypersurface currently not supported for this model"
+  @req base_space(m) isa NormalToricVariety "Calabi-Yau hypersurface currently only supported for toric varieties as base space"
+  is_base_space_fully_specified(m) || @vprint :FTheoryModelPrinter 1 "Base space was not fully specified. Returning hypersurface in AUXILIARY ambient space.\n"
+  return closed_subvariety_of_toric_variety(ambient_space(m), [hypersurface_equation(m)])
+end
+
+
 ######################################################################################
 ### Attributes for flux families (not exported, rather for serialization overhaul)
 ######################################################################################

experimental/FTheoryTools/src/HypersurfaceModels/attributes.jl

@@ -174,38 +174,6 @@ function global_tate_model(h::HypersurfaceModel)
 end
 
 
-@doc raw"""
-    calabi_yau_hypersurface(h::HypersurfaceModel)
-
-Return the Calabi–Yau hypersurface that defines the hypersurface model
-as a closed subvariety of its toric ambient space.
-
-# Examples
-```jldoctest
-julia> b = projective_space(NormalToricVariety, 2);
-
-julia> kb = anticanonical_divisor_class(b);
-
-julia> fiber_ambient = weighted_projective_space(NormalToricVariety, [2, 3, 1]);
-
-julia> set_coordinate_names(fiber_ambient, ["x", "y", "z"]);
-
-julia> p = "x^3 - y^2 + x1^12 * x * z^4 + x2^18 * z^6 + 13 * x3^3*x*y*z";
-
-julia> h = hypersurface_model(b, fiber_ambient, [2 * kb, 3 * kb], p; completeness_check=false)
-Hypersurface model over a concrete base
-
-julia> calabi_yau_hypersurface(h)
-Closed subvariety of a normal toric variety
-```
-"""
-@attr ClosedSubvarietyOfToricVariety function calabi_yau_hypersurface(h::HypersurfaceModel)
-  @req base_space(h) isa NormalToricVariety "Calabi-Yau hypersurface currently only supported for toric varieties as base space"
-  is_base_space_fully_specified(h) || @vprint :FTheoryModelPrinter 1 "Base space was not fully specified. Returning hypersurface in AUXILIARY ambient space.\n"
-  return closed_subvariety_of_toric_variety(ambient_space(h), [hypersurface_equation(h)])
-end
-
-
 @doc raw"""
     discriminant(h::HypersurfaceModel)
 

experimental/FTheoryTools/src/TateModels/attributes.jl

@@ -165,28 +165,6 @@ function tate_ideal_sheaf(t::GlobalTateModel)
 end
 
 
-@doc raw"""
-    calabi_yau_hypersurface(t::GlobalTateModel)
-
-Return the Calabi–Yau hypersurface that defines the global Tate model
-as a closed subvariety of its toric ambient space.
-
-# Examples
-```jldoctest
-julia> t = global_tate_model_over_projective_space(2)
-Global Tate model over a concrete base
-
-julia> calabi_yau_hypersurface(t)
-Closed subvariety of a normal toric variety
-```
-"""
-@attr ClosedSubvarietyOfToricVariety function calabi_yau_hypersurface(t::GlobalTateModel)
-  @req base_space(t) isa NormalToricVariety "Calabi-Yau hypersurface currently only supported for toric varieties as base space"
-  is_base_space_fully_specified(t) || @vprint :FTheoryModelPrinter 1 "Base space was not fully specified. Returning hypersurface in AUXILIARY ambient space.\n"
-  return closed_subvariety_of_toric_variety(ambient_space(t), [tate_polynomial(t)])
-end
-
-
 @doc raw"""
     weierstrass_model(t::GlobalTateModel)
 

experimental/FTheoryTools/src/WeierstrassModels/attributes.jl

@@ -112,28 +112,6 @@ function weierstrass_ideal_sheaf(w::WeierstrassModel)
 end
 
 
-@doc raw"""
-    calabi_yau_hypersurface(w::WeierstrassModel)
-
-Return the Calabi–Yau hypersurface that defines the Weierstrass model
-as a closed subvariety of its toric ambient space.
-
-# Examples
-```jldoctest
-julia> w =  weierstrass_model_over_projective_space(3)
-Weierstrass model over a concrete base
-
-julia> calabi_yau_hypersurface(w)
-Closed subvariety of a normal toric variety
-```
-"""
-@attr ClosedSubvarietyOfToricVariety function calabi_yau_hypersurface(w::WeierstrassModel)
-  @req base_space(w) isa NormalToricVariety "Calabi-Yau hypersurface currently only supported for toric varieties as base space"
-  is_base_space_fully_specified(w) || @vprint :FTheoryModelPrinter 1 "Base space was not fully specified. Returning hypersurface in AUXILIARY ambient space.\n"
-  return closed_subvariety_of_toric_variety(ambient_space(w), [weierstrass_polynomial(w)])
-end
-
-
 @doc raw"""
     discriminant(w::WeierstrassModel)