IShape.h File Reference

Include dependency graph for IShape.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
class	IShape

Functions
std::vector< kvector_t >	RectangleVertices (double length, double width, double z)
std::vector< kvector_t >	EllipseVertices (double r_x, double r_y, double z)

Detailed Description

Defines interface IShape.

Homepage:\n http://www.bornagainproject.org

License:\n GNU General Public License v3 or higher (see COPYING)

Copyright

Forschungszentrum Jülich GmbH 2018

Authors

Scientific Computing Group at MLZ (see CITATION, AUTHORS)

Definition in file IShape.h.

Function Documentation

RectangleVertices()

std::vector<kvector_t> RectangleVertices	(	double	length,
		double	width,
		double	z
	)

Helper functions to construct lists of vertices.

Generate vertices of centered rectangle at height z

Definition at line 28 of file IShape.cpp.

{
    std::vector<kvector_t> result = {{length / 2.0, width / 2.0, z},
                                     {-length / 2.0, width / 2.0, z},
                                     {-length / 2.0, -width / 2.0, z},
                                     {length / 2.0, -width / 2.0, z}};
    return result;
}

References anonymous_namespace{BoxCompositionBuilder.cpp}::length, and anonymous_namespace{BoxCompositionBuilder.cpp}::width.

Referenced by Box::Box().

EllipseVertices()

std::vector<kvector_t> EllipseVertices	(	double	r_x,
		double	r_y,
		double	z
	)

Generate vertices of centered ellipse with given semi-axes at height z.

Definition at line 37 of file IShape.cpp.

{
    static constexpr double delta_angle = 2.0 * M_PI / IShape::N_Circle;
    std::vector<kvector_t> result(IShape::N_Circle);
    for (size_t i = 0; i < IShape::N_Circle; ++i) {
        double angle = i * delta_angle;
        double x = r_x * std::cos(angle);
        double y = r_y * std::sin(angle);
        result[i] = kvector_t(x, y, z);
    }
    return result;
}

References M_PI, and IShape::N_Circle.

Referenced by DoubleEllipse::DoubleEllipse(), and TruncatedEllipsoid::TruncatedEllipsoid().