Skip to content

Switched absolute to relative additional radius #382

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
nicogno wants to merge 6 commits into
base: master
Choose a base branch
from
Open

Switched absolute to relative additional radius #382

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
921cfdd
Switched absolute to relative additional radius
Aug 2, 2024
42f5017
Updated test values
Aug 6, 2024
7e4b89e
Format
Aug 6, 2024
782b5d4
Made virtual agent radius scale factor adjustable by user
Aug 7, 2024
a028957
Fixed issue raised by SonarCloud
Aug 8, 2024
41da36a
Merge branch 'master' into relativeAdditionalRadiusForce
Aug 8, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions src/core/interaction_force.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,21 +62,21 @@ void InteractionForce::ForceBetweenSpheres(const Agent* sphere_lhs,
Real3* result) const {
const Real3& ref_mass_location = sphere_lhs->GetPosition();
real_t ref_diameter = sphere_lhs->GetDiameter();
real_t ref_iof_coefficient = 0.15;
const Real3& nb_mass_location = sphere_rhs->GetPosition();
real_t nb_diameter = sphere_rhs->GetDiameter();
real_t nb_iof_coefficient = 0.15;
const auto* sim = Simulation::GetActive();
auto* param = sim->GetParam();

auto c1 = ref_mass_location;
real_t r1 = 0.5 * ref_diameter;
auto c2 = nb_mass_location;
real_t r2 = 0.5 * nb_diameter;
// We take virtual bigger radii to have a distant interaction, to get a
// desired density.
real_t additional_radius =
10.0 * std::min(ref_iof_coefficient, nb_iof_coefficient);
r1 += additional_radius;
r2 += additional_radius;
// desired density. We assume an interaction distance 3% larger then the
// agent's radius by default

r1 *= param->virtual_agent_radius_scale_factor;
r2 *= param->virtual_agent_radius_scale_factor;
// the 3 components of the vector c2 -> c1
real_t comp1 = c1[0] - c2[0];
real_t comp2 = c1[1] - c2[1];
Expand Down
2 changes: 2 additions & 0 deletions src/core/param/param.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -242,6 +242,8 @@ void Param::AssignFromConfig(const std::shared_ptr<cpptoml::table>& config) {
BDM_ASSIGN_CONFIG_VALUE(diffusion_method, "simulation.diffusion_method");
BDM_ASSIGN_CONFIG_VALUE(calculate_gradients,
"simulation.calculate_gradients");
BDM_ASSIGN_CONFIG_VALUE(virtual_agent_radius_scale_factor,
"simulation.virtual_agent_radius_scale_factor");
AssignBoundSpaceMode(config, this);
AssignThreadSafetyMechanism(config, this);

Expand Down
8 changes: 8 additions & 0 deletions src/core/param/param.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -264,6 +264,14 @@ struct Param {
/// calculate_gradients = true
bool calculate_gradients = true;

/// Scale agent's virtual radius to enable distant interactions.\n
/// TOML config file:
/// Default value: `"1.03"`\n TOML
///
/// [simulation]
/// virtual_agent_radius_scale_factor = 1.03
real_t virtual_agent_radius_scale_factor = 1.03;

/// List of thread-safety mechanisms \n
/// `kNone`: \n
/// `kUserSpecified`: The user has to define all agent that must
Expand Down
20 changes: 13 additions & 7 deletions test/unit/core/interaction_force_test.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,20 +37,26 @@ TEST(InteractionForce, GeneralSphere) {
InteractionForce force;
auto result = force.Calculate(&cell, &nb);

EXPECT_NEAR(7.1429184067241138, result[0], abs_error<real_t>::value);
EXPECT_NEAR(6.4935621879310119, result[1], abs_error<real_t>::value);
EXPECT_NEAR(5.8442059691379109, result[2], abs_error<real_t>::value);
EXPECT_NEAR(4.50152537445543206341835066295, result[0],
abs_error<real_t>::value);
EXPECT_NEAR(4.09229579495948369401668242086, result[1],
abs_error<real_t>::value);
EXPECT_NEAR(3.68306621546353532461501417877, result[2],
abs_error<real_t>::value);

nb.SetDiameter(10);
nb.SetPosition({5, 5, 0});
result = force.Calculate(&cell, &nb);

EXPECT_NEAR(-5.7454658831720176, result[0], abs_error<real_t>::value);
EXPECT_NEAR(-5.892785521202069, result[1], abs_error<real_t>::value);
EXPECT_NEAR(1.3258767422704656, result[2], abs_error<real_t>::value);
EXPECT_NEAR(-2.99648347356091527350007596923, result[0],
abs_error<real_t>::value);
EXPECT_NEAR(-3.07331638313940028051289842998, result[1],
abs_error<real_t>::value);
EXPECT_NEAR(0.691496186206365063115402146746, result[2],
abs_error<real_t>::value);
}

/// Tests the special case that non of the neighbors overlap
/// Tests the special case that none of the neighbors overlap
/// with the reference cell
TEST(InteractionForce, AllNonOverlappingSphere) {
Simulation simulation(TEST_NAME);
Expand Down
60 changes: 31 additions & 29 deletions test/unit/core/operation/mechanical_forces_op_test.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,13 +59,14 @@ inline void RunTest(const std::string& environment) {
Cell* final_cell1 = dynamic_cast<Cell*>(rm->GetAgent(ref_uid + 1));
auto final_position = final_cell0->GetPosition();
EXPECT_NEAR(0, final_position[0], abs_error<real_t>::value);
EXPECT_NEAR(-0.07797206232558615, final_position[1],
EXPECT_NEAR(-0.0494590384253325649715244643239, final_position[1],
abs_error<real_t>::value);
EXPECT_NEAR(0, final_position[2], abs_error<real_t>::value);
// cell 1
final_position = final_cell1->GetPosition();
EXPECT_NEAR(0, final_position[0], abs_error<real_t>::value);
EXPECT_NEAR(5.0980452768658333, final_position[1], abs_error<real_t>::value);
EXPECT_NEAR(5.06220489350739084993450043382, final_position[1],
abs_error<real_t>::value);
EXPECT_NEAR(0, final_position[2], abs_error<real_t>::value);

// check if tractor_force has been reset to zero
Expand Down Expand Up @@ -129,33 +130,34 @@ inline void RunTest2(const std::string& environment) {
}

// clang-format off
EXPECT_ARR_NEAR(rm->GetAgent(ref_uid + 0)->GetPosition(), {-0.20160966809506442, -0.20160966809506442, -0.20160966809506442});
EXPECT_ARR_NEAR(rm->GetAgent(ref_uid + 1)->GetPosition(), {19.996726567569418, -0.22266672163763598, -0.22266672163763598});
EXPECT_ARR_NEAR(rm->GetAgent(ref_uid + 2)->GetPosition(), {40.201498173927305, -0.19986951265938641, -0.19986951265938641});
EXPECT_ARR_NEAR(rm->GetAgent(ref_uid + 3)->GetPosition(), {-0.22107235667371566, 19.99536937981701, -0.22243298066161277});
EXPECT_ARR_NEAR(rm->GetAgent(ref_uid + 4)->GetPosition(), {19.996445694277536, 19.991084649064845, -0.24302072168423453});
EXPECT_ARR_NEAR(rm->GetAgent(ref_uid + 5)->GetPosition(), {40.220941141351886, 19.995420431150347, -0.22054684872504365});
EXPECT_ARR_NEAR(rm->GetAgent(ref_uid + 6)->GetPosition(), {-0.19982869510573351, 40.201437349791846, -0.19959785780667869});
EXPECT_ARR_NEAR(rm->GetAgent(ref_uid + 7)->GetPosition(), {19.99678197072755, 40.219229813316794, -0.22031963374181529});
EXPECT_ARR_NEAR(rm->GetAgent(ref_uid + 8)->GetPosition(), {40.199677082903456, 40.19967381378099, -0.19789135788064738});
EXPECT_ARR_NEAR(rm->GetAgent(ref_uid + 9)->GetPosition(), {-0.2208401632148318, -0.22084860029084805, 19.994023485540392});
EXPECT_ARR_NEAR(rm->GetAgent(ref_uid + 10)->GetPosition(), {19.996453518945092, -0.2413353410797266, 19.989660774799667});
EXPECT_ARR_NEAR(rm->GetAgent(ref_uid + 11)->GetPosition(), {40.220709535497228, -0.21898884436167229, 19.994096990730121});
EXPECT_ARR_NEAR(rm->GetAgent(ref_uid + 12)->GetPosition(), {-0.23959752549368377, 19.995004901057818, 19.989639428390195});
EXPECT_ARR_NEAR(rm->GetAgent(ref_uid + 13)->GetPosition(), {19.996198530091725, 19.99036483907971, 19.984534769039289});
EXPECT_ARR_NEAR(rm->GetAgent(ref_uid + 14)->GetPosition(), {40.239451672678122, 19.995058936152933, 19.989784932711256});
EXPECT_ARR_NEAR(rm->GetAgent(ref_uid + 15)->GetPosition(), {-0.21895170976356038, 40.220651199374309, 19.994102585380165});
EXPECT_ARR_NEAR(rm->GetAgent(ref_uid + 16)->GetPosition(), {19.996511705095408, 40.237587787915302, 19.989763131796483});
EXPECT_ARR_NEAR(rm->GetAgent(ref_uid + 17)->GetPosition(), {40.218778612717593, 40.218767244773701, 19.994175099676564});
EXPECT_ARR_NEAR(rm->GetAgent(ref_uid + 18)->GetPosition(), {-0.19955064743630646, -0.19955761561629054, 40.201369950961137});
EXPECT_ARR_NEAR(rm->GetAgent(ref_uid + 19)->GetPosition(), {19.99679050342159, -0.22028367546827032, 40.219170471740057});
EXPECT_ARR_NEAR(rm->GetAgent(ref_uid + 20)->GetPosition(), {40.199399442577274, -0.19785191118676104, 40.199607855810939});
EXPECT_ARR_NEAR(rm->GetAgent(ref_uid + 21)->GetPosition(), {-0.2186842147430082, 19.995465190535288, 40.218898427254011});
EXPECT_ARR_NEAR(rm->GetAgent(ref_uid + 22)->GetPosition(), {19.996519321027819, 19.991238784452595, 40.235673745336591});
EXPECT_ARR_NEAR(rm->GetAgent(ref_uid + 23)->GetPosition(), {40.218511916378013, 19.995514817696375, 40.217044778537549});
EXPECT_ARR_NEAR(rm->GetAgent(ref_uid + 24)->GetPosition(), {-0.19780590198157336, 40.19933398679354, 40.199323871317965});
EXPECT_ARR_NEAR(rm->GetAgent(ref_uid + 25)->GetPosition(), {19.996843796541615, 40.216799284843852, 40.216779234925141});
EXPECT_ARR_NEAR(rm->GetAgent(ref_uid + 26)->GetPosition(), {40.197616806612238, 40.197607143403182, 40.197597121203316});
EXPECT_ARR_NEAR(rm->GetAgent(ref_uid + 0)->GetPosition(), {-0.136650834179647427449523566794, -0.136650834179647427449523566794, -0.136650834179647427449523566794});
EXPECT_ARR_NEAR(rm->GetAgent(ref_uid + 1)->GetPosition(), {19.9978236653235009314379819452, -0.141015306673735183678484988771, -0.141015306673735183678484988771});
EXPECT_ARR_NEAR(rm->GetAgent(ref_uid + 2)->GetPosition(), {40.1365944997387418724705928750, -0.13576125310507888313992208380, -0.13576125310507888313992208380});
EXPECT_ARR_NEAR(rm->GetAgent(ref_uid + 3)->GetPosition(), {-0.14020905712356290333724784449, 19.9970489222767306358984663823, -0.140984279029959657535431602871});
EXPECT_ARR_NEAR(rm->GetAgent(ref_uid + 4)->GetPosition(), {19.9977851373048793139637014758, 19.9947099058674891346242305069, -0.145277624139375911514663940516});
EXPECT_ARR_NEAR(rm->GetAgent(ref_uid + 5)->GetPosition(), {40.1401388185864714084643836652, 19.9970715249564464264518999951, -0.14007326379892509482257787044});
EXPECT_ARR_NEAR(rm->GetAgent(ref_uid + 6)->GetPosition(), {-0.13574486720051072606503005095, 40.1365627529316842850017320254, -0.135723902739067722287343804703});
EXPECT_ARR_NEAR(rm->GetAgent(ref_uid + 7)->GetPosition(), {19.9978515057522633535842662641, 40.1392617421792200453064082392, -0.140043337731872570780977206275});
EXPECT_ARR_NEAR(rm->GetAgent(ref_uid + 8)->GetPosition(), {40.1356651625421862223149400611, 40.1356589129132839546632435903, -0.134846375207706975815553682423});
EXPECT_ARR_NEAR(rm->GetAgent(ref_uid + 9)->GetPosition(), {-0.140178174501168932165811283971, -0.140182476858812768317650143102, 19.9962788234873976200766333855});
EXPECT_ARR_NEAR(rm->GetAgent(ref_uid + 10)->GetPosition(), {19.9977862308751720034084509786, -0.144471737809141948159807531113, 19.9939369302356357458986222506});
EXPECT_ARR_NEAR(rm->GetAgent(ref_uid + 11)->GetPosition(), {40.1401080571319587799692461333, -0.139281644960194857517683474124, 19.9963112337827742562800909788});
EXPECT_ARR_NEAR(rm->GetAgent(ref_uid + 12)->GetPosition(), {-0.143636884973078624410733274983, 19.9970003497588359473907353340, 19.9939216324133267598249705192});
EXPECT_ARR_NEAR(rm->GetAgent(ref_uid + 13)->GetPosition(), {19.9977509281001790744848931789, 19.9946123129189552912189860276, 19.9914755278624715229091673136});
EXPECT_ARR_NEAR(rm->GetAgent(ref_uid + 14)->GetPosition(), {40.1435533751884737842596265535, 19.9970230447662831556627447542, 19.9939839395317135001120125930});
EXPECT_ARR_NEAR(rm->GetAgent(ref_uid + 15)->GetPosition(), {-0.139264372505880738304090978511, 40.1400752445670986163454723481, 19.9963056313964950800704680887});
EXPECT_ARR_NEAR(rm->GetAgent(ref_uid + 16)->GetPosition(), {19.9978140032122536103189974908, 40.1426469666206381715941682442, 19.9939685327911046231094964962});
EXPECT_ARR_NEAR(rm->GetAgent(ref_uid + 17)->GetPosition(), {40.1391708994512008085005089423, 40.1391603959532489256165370155, 19.9963378247512290443404377838});
EXPECT_ARR_NEAR(rm->GetAgent(ref_uid + 18)->GetPosition(), {-0.135703460393067269278536235005, -0.135707572042464525088701330238, 40.1365270491528043523269029624});
EXPECT_ARR_NEAR(rm->GetAgent(ref_uid + 19)->GetPosition(), {19.9978526859614648754687984712, -0.140029334896406153010924586016, 40.1392258289244541720704728805});
EXPECT_ARR_NEAR(rm->GetAgent(ref_uid + 20)->GetPosition(), {40.1356238143556917587581200186, -0.13483030541778221502463362419, 40.1356238215903481357585777958});
EXPECT_ARR_NEAR(rm->GetAgent(ref_uid + 21)->GetPosition(), {-0.139216463603416178525167668456, 19.9970888470926410320886260158, 40.1391768764013402113023482055});
EXPECT_ARR_NEAR(rm->GetAgent(ref_uid + 22)->GetPosition(), {19.9978151330991056052596669472, 19.9947714402862555915866948948, 40.1417125181374631632487142307});
EXPECT_ARR_NEAR(rm->GetAgent(ref_uid + 23)->GetPosition(), {40.1391231591415114231657215943, 19.9971109750473197461909678817, 40.1382739675789673370998391272});
EXPECT_ARR_NEAR(rm->GetAgent(ref_uid + 24)->GetPosition(), {-0.134810200828153573232552824888, 40.1355886055729997034154133547, 40.1355781327590436272539263897});
EXPECT_ARR_NEAR(rm->GetAgent(ref_uid + 25)->GetPosition(), {19.9978797095407642059976814643, 40.1382410601235742697478311222, 40.1382260635760805291432435869});
EXPECT_ARR_NEAR(rm->GetAgent(ref_uid + 26)->GetPosition(), {40.1347081112982584823528491696, 40.1346979778000455604454679675, 40.1346876663558284147859833527});

// clang-format on

delete mechanical_forces_op;
Expand Down