ASPECT
Public Member Functions | Static Public Member Functions | Private Attributes | List of all members
aspect::InitialTemperature::HarmonicPerturbation< dim > Class Template Reference
Describing initial conditions » Describing initial conditions for the temperature
Inheritance diagram for aspect::InitialTemperature::HarmonicPerturbation< dim >:
Inheritance graph
[legend]

Public Member Functions

double initial_temperature (const Point< dim > &position) const override
 
void parse_parameters (ParameterHandler &prm) override
 
- Public Member Functions inherited from aspect::Plugins::InterfaceBase
virtual ~InterfaceBase ()=default
 
virtual void initialize ()
 
virtual void update ()
 
- Public Member Functions inherited from aspect::SimulatorAccess< dim >
 SimulatorAccess ()
 
 SimulatorAccess (const Simulator< dim > &simulator_object)
 
virtual ~SimulatorAccess ()=default
 
virtual void initialize_simulator (const Simulator< dim > &simulator_object)
 
const Introspection< dim > & introspection () const
 
const Simulator< dim > & get_simulator () const
 
const Parameters< dim > & get_parameters () const
 
SimulatorSignals< dim > & get_signals () const
 
MPI_Comm get_mpi_communicator () const
 
TimerOutput & get_computing_timer () const
 
const ConditionalOStream & get_pcout () const
 
double get_time () const
 
double get_timestep () const
 
double get_old_timestep () const
 
unsigned int get_timestep_number () const
 
const TimeStepping::Manager< dim > & get_timestepping_manager () const
 
unsigned int get_nonlinear_iteration () const
 
const parallel::distributed::Triangulation< dim > & get_triangulation () const
 
double get_volume () const
 
const Mapping< dim > & get_mapping () const
 
std::string get_output_directory () const
 
bool include_adiabatic_heating () const
 
bool include_latent_heat () const
 
bool include_melt_transport () const
 
int get_stokes_velocity_degree () const
 
double get_adiabatic_surface_temperature () const
 
double get_surface_pressure () const
 
bool convert_output_to_years () const
 
unsigned int get_pre_refinement_step () const
 
unsigned int n_compositional_fields () const
 
double get_end_time () const
 
void get_refinement_criteria (Vector< float > &estimated_error_per_cell) const
 
void get_artificial_viscosity (Vector< float > &viscosity_per_cell, const bool skip_interior_cells=false) const
 
void get_artificial_viscosity_composition (Vector< float > &viscosity_per_cell, const unsigned int compositional_variable) const
 
const LinearAlgebra::BlockVector & get_current_linearization_point () const
 
const LinearAlgebra::BlockVector & get_solution () const
 
const LinearAlgebra::BlockVector & get_old_solution () const
 
const LinearAlgebra::BlockVector & get_old_old_solution () const
 
const LinearAlgebra::BlockVector & get_reaction_vector () const
 
const LinearAlgebra::BlockVector & get_mesh_velocity () const
 
const DoFHandler< dim > & get_dof_handler () const
 
const FiniteElement< dim > & get_fe () const
 
const LinearAlgebra::BlockSparseMatrix & get_system_matrix () const
 
const LinearAlgebra::BlockSparseMatrix & get_system_preconditioner_matrix () const
 
const MaterialModel::Interface< dim > & get_material_model () const
 
const GravityModel::Interface< dim > & get_gravity_model () const
 
const InitialTopographyModel::Interface< dim > & get_initial_topography_model () const
 
const GeometryModel::Interface< dim > & get_geometry_model () const
 
const AdiabaticConditions::Interface< dim > & get_adiabatic_conditions () const
 
bool has_boundary_temperature () const
 
const BoundaryTemperature::Manager< dim > & get_boundary_temperature_manager () const
 
const BoundaryHeatFlux::Interface< dim > & get_boundary_heat_flux () const
 
bool has_boundary_composition () const
 
const BoundaryComposition::Manager< dim > & get_boundary_composition_manager () const
 
const BoundaryTraction::Manager< dim > & get_boundary_traction_manager () const
 
std::shared_ptr< const InitialTemperature::Manager< dim > > get_initial_temperature_manager_pointer () const
 
const InitialTemperature::Manager< dim > & get_initial_temperature_manager () const
 
std::shared_ptr< const InitialComposition::Manager< dim > > get_initial_composition_manager_pointer () const
 
const InitialComposition::Manager< dim > & get_initial_composition_manager () const
 
const std::set< types::boundary_id > & get_fixed_temperature_boundary_indicators () const
 
const std::set< types::boundary_id > & get_fixed_heat_flux_boundary_indicators () const
 
const std::set< types::boundary_id > & get_fixed_composition_boundary_indicators () const
 
const std::set< types::boundary_id > & get_mesh_deformation_boundary_indicators () const
 
const BoundaryVelocity::Manager< dim > & get_boundary_velocity_manager () const
 
const HeatingModel::Manager< dim > & get_heating_model_manager () const
 
const MeshRefinement::Manager< dim > & get_mesh_refinement_manager () const
 
const MeltHandler< dim > & get_melt_handler () const
 
const VolumeOfFluidHandler< dim > & get_volume_of_fluid_handler () const
 
const NewtonHandler< dim > & get_newton_handler () const
 
const MeshDeformation::MeshDeformationHandler< dim > & get_mesh_deformation_handler () const
 
const LateralAveraging< dim > & get_lateral_averaging () const
 
const AffineConstraints< double > & get_current_constraints () const
 
bool simulator_is_past_initialization () const
 
double get_pressure_scaling () const
 
bool pressure_rhs_needs_compatibility_modification () const
 
bool model_has_prescribed_stokes_solution () const
 
TableHandler & get_statistics_object () const
 
const Postprocess::Manager< dim > & get_postprocess_manager () const
 
unsigned int n_particle_managers () const
 
const Particle::Manager< dim > & get_particle_manager (const unsigned int particle_manager_index) const
 
Particle::Manager< dim > & get_particle_manager (const unsigned int particle_manager_index)
 
bool is_stokes_matrix_free ()
 
const StokesMatrixFreeHandler< dim > & get_stokes_matrix_free () const
 
RotationProperties< dim > compute_net_angular_momentum (const bool use_constant_density, const LinearAlgebra::BlockVector &solution, const bool limit_to_top_faces=false) const
 

Static Public Member Functions

static void declare_parameters (ParameterHandler &prm)
 
- Static Public Member Functions inherited from aspect::Plugins::InterfaceBase
static void declare_parameters (ParameterHandler &prm)
 
- Static Public Member Functions inherited from aspect::SimulatorAccess< dim >
static void get_composition_values_at_q_point (const std::vector< std::vector< double >> &composition_values, const unsigned int q, std::vector< double > &composition_values_at_q_point)
 

Private Attributes

int vertical_wave_number
 
int lateral_wave_number_1
 
int lateral_wave_number_2
 
double magnitude
 
double reference_temperature
 

Detailed Description

template<int dim>
class aspect::InitialTemperature::HarmonicPerturbation< dim >

A class that describes a perturbed initially constant temperature field for any geometry model or dimension in shape of a harmonic function. For 3D spherical shell models this is achieved by using spherical harmonics, in any other case sine function are scaled to fit the model geometry.

Definition at line 45 of file harmonic_perturbation.h.

Member Function Documentation

§ initial_temperature()

template<int dim>
double aspect::InitialTemperature::HarmonicPerturbation< dim >::initial_temperature ( const Point< dim > &  position) const
overridevirtual

Return the initial temperature as a function of position.

Implements aspect::InitialTemperature::Interface< dim >.

§ declare_parameters()

template<int dim>
static void aspect::InitialTemperature::HarmonicPerturbation< dim >::declare_parameters ( ParameterHandler &  prm)
static

Declare the parameters this class takes through input files.

§ parse_parameters()

template<int dim>
void aspect::InitialTemperature::HarmonicPerturbation< dim >::parse_parameters ( ParameterHandler &  prm)
overridevirtual

Read the parameters this class declares from the parameter file.

Reimplemented from aspect::Plugins::InterfaceBase.

Member Data Documentation

§ vertical_wave_number

template<int dim>
int aspect::InitialTemperature::HarmonicPerturbation< dim >::vertical_wave_number
private

The radial/depth wave number of the harmonic perturbation. All wave number variables are in fact twice the wave number in a mathematical sense. This allows the user to prescribe a single up-/downswing or half periods.

Definition at line 75 of file harmonic_perturbation.h.

§ lateral_wave_number_1

template<int dim>
int aspect::InitialTemperature::HarmonicPerturbation< dim >::lateral_wave_number_1
private

The lateral wave number of the harmonic perturbation in the first dimension. This is the only lateral wave number in 2D and equals the degree of the spherical harmonics in a 3D spherical shell.

Definition at line 82 of file harmonic_perturbation.h.

§ lateral_wave_number_2

template<int dim>
int aspect::InitialTemperature::HarmonicPerturbation< dim >::lateral_wave_number_2
private

The lateral wave number of the harmonic perturbation in the second dimension. This is not used in 2D and equals the order of the spherical harmonics in a 3D spherical shell.

Definition at line 89 of file harmonic_perturbation.h.

§ magnitude

template<int dim>
double aspect::InitialTemperature::HarmonicPerturbation< dim >::magnitude
private

The maximal magnitude of the harmonic perturbation.

Definition at line 94 of file harmonic_perturbation.h.

§ reference_temperature

template<int dim>
double aspect::InitialTemperature::HarmonicPerturbation< dim >::reference_temperature
private

The background temperature the harmonic perturbation is applied on in an incompressible material model. In case of a compressible material model the perturbation is applied on top of an adiabatic profile and this variable is not used at all.

Definition at line 102 of file harmonic_perturbation.h.

The documentation for this class was generated from the following file: