File: Box.hpp

package info (click to toggle)
yade 2026.1.0-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 34,448 kB
  • sloc: cpp: 97,645; python: 52,173; sh: 677; makefile: 162
file content (35 lines) | stat: -rw-r--r-- 1,225 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
/*************************************************************************
*  Copyright (C) 2004 by Olivier Galizzi                                 *
*  olivier.galizzi@imag.fr                                               *
*                                                                        *
*  This program is free software; it is licensed under the terms of the  *
*  GNU General Public License v2 or later. See file LICENSE for details. *
*************************************************************************/

#pragma once

#include <core/Shape.hpp>

namespace yade { // Cannot have #include directive inside.

class Box : public Shape {
public:
	Box(const Vector3r& _extents)
	        : extents(_extents)
	{
	}
	Real getVolume() override { return 8. * extents.prod(); };
	virtual ~Box() {};
	// clang-format off
	YADE_CLASS_BASE_DOC_ATTRS_CTOR_PY(Box,Shape,"Box (cuboid) particle geometry. (Avoid using in new code, prefer :yref:`Facet` instead.)",
		((Vector3r,extents,,,"Half-size of the cuboid")),
		/* ctor */ createIndex();
		,
		.def("getVolume",&Box::getVolume,"Returns the shape volume.")
	);
	// clang-format on
	REGISTER_CLASS_INDEX(Box, Shape);
};
REGISTER_SERIALIZABLE(Box);

} // namespace yade